1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
//===- ProfileSummaryInfoTest.cpp - ProfileSummaryInfo unit tests ---------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "llvm/Analysis/ProfileSummaryInfo.h"
#include "llvm/Analysis/BlockFrequencyInfo.h"
#include "llvm/Analysis/BranchProbabilityInfo.h"
#include "llvm/Analysis/LoopInfo.h"
#include "llvm/AsmParser/Parser.h"
#include "llvm/IR/BasicBlock.h"
#include "llvm/IR/CallSite.h"
#include "llvm/IR/Dominators.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/MDBuilder.h"
#include "llvm/IR/Module.h"
#include "llvm/Support/DataTypes.h"
#include "llvm/Support/FormatVariadic.h"
#include "llvm/Support/SourceMgr.h"
#include "llvm/Support/raw_ostream.h"
#include "gtest/gtest.h"
namespace llvm {
namespace {
class ProfileSummaryInfoTest : public testing::Test {
protected:
LLVMContext C;
std::unique_ptr<BranchProbabilityInfo> BPI;
std::unique_ptr<DominatorTree> DT;
std::unique_ptr<LoopInfo> LI;
ProfileSummaryInfo buildPSI(Module *M) {
return ProfileSummaryInfo(*M);
}
BlockFrequencyInfo buildBFI(Function &F) {
DT.reset(new DominatorTree(F));
LI.reset(new LoopInfo(*DT));
BPI.reset(new BranchProbabilityInfo(F, *LI));
return BlockFrequencyInfo(F, *BPI, *LI);
}
std::unique_ptr<Module> makeLLVMModule(const char *ProfKind = nullptr) {
const char *ModuleString =
"define i32 @g(i32 %x) !prof !21 {{\n"
" ret i32 0\n"
"}\n"
"define i32 @h(i32 %x) !prof !22 {{\n"
" ret i32 0\n"
"}\n"
"define i32 @f(i32 %x) !prof !20 {{\n"
"bb0:\n"
" %y1 = icmp eq i32 %x, 0 \n"
" br i1 %y1, label %bb1, label %bb2, !prof !23 \n"
"bb1:\n"
" %z1 = call i32 @g(i32 %x)\n"
" br label %bb3\n"
"bb2:\n"
" %z2 = call i32 @h(i32 %x)\n"
" br label %bb3\n"
"bb3:\n"
" %y2 = phi i32 [0, %bb1], [1, %bb2] \n"
" ret i32 %y2\n"
"}\n"
"!20 = !{{!\"function_entry_count\", i64 400}\n"
"!21 = !{{!\"function_entry_count\", i64 1}\n"
"!22 = !{{!\"function_entry_count\", i64 100}\n"
"!23 = !{{!\"branch_weights\", i32 64, i32 4}\n"
"{0}";
const char *SummaryString = "!llvm.module.flags = !{{!1}"
"!1 = !{{i32 1, !\"ProfileSummary\", !2}"
"!2 = !{{!3, !4, !5, !6, !7, !8, !9, !10}"
"!3 = !{{!\"ProfileFormat\", !\"{0}\"}"
"!4 = !{{!\"TotalCount\", i64 10000}"
"!5 = !{{!\"MaxCount\", i64 10}"
"!6 = !{{!\"MaxInternalCount\", i64 1}"
"!7 = !{{!\"MaxFunctionCount\", i64 1000}"
"!8 = !{{!\"NumCounts\", i64 3}"
"!9 = !{{!\"NumFunctions\", i64 3}"
"!10 = !{{!\"DetailedSummary\", !11}"
"!11 = !{{!12, !13, !14}"
"!12 = !{{i32 10000, i64 1000, i32 1}"
"!13 = !{{i32 999000, i64 300, i32 3}"
"!14 = !{{i32 999999, i64 5, i32 10}";
SMDiagnostic Err;
if (ProfKind)
return parseAssemblyString(
formatv(ModuleString, formatv(SummaryString, ProfKind).str()).str(),
Err, C);
else
return parseAssemblyString(formatv(ModuleString, "").str(), Err, C);
}
};
TEST_F(ProfileSummaryInfoTest, TestNoProfile) {
auto M = makeLLVMModule(/*ProfKind=*/nullptr);
Function *F = M->getFunction("f");
ProfileSummaryInfo PSI = buildPSI(M.get());
EXPECT_FALSE(PSI.hasProfileSummary());
EXPECT_FALSE(PSI.hasSampleProfile());
EXPECT_FALSE(PSI.hasInstrumentationProfile());
// In the absence of profiles, is{Hot|Cold}X methods should always return
// false.
EXPECT_FALSE(PSI.isHotCount(1000));
EXPECT_FALSE(PSI.isHotCount(0));
EXPECT_FALSE(PSI.isColdCount(1000));
EXPECT_FALSE(PSI.isColdCount(0));
EXPECT_FALSE(PSI.isFunctionEntryHot(F));
EXPECT_FALSE(PSI.isFunctionEntryCold(F));
BasicBlock &BB0 = F->getEntryBlock();
BasicBlock *BB1 = BB0.getTerminator()->getSuccessor(0);
BlockFrequencyInfo BFI = buildBFI(*F);
EXPECT_FALSE(PSI.isHotBlock(&BB0, &BFI));
EXPECT_FALSE(PSI.isColdBlock(&BB0, &BFI));
CallSite CS1(BB1->getFirstNonPHI());
EXPECT_FALSE(PSI.isHotCallSite(CS1, &BFI));
EXPECT_FALSE(PSI.isColdCallSite(CS1, &BFI));
}
TEST_F(ProfileSummaryInfoTest, TestCommon) {
auto M = makeLLVMModule("InstrProf");
Function *F = M->getFunction("f");
Function *G = M->getFunction("g");
Function *H = M->getFunction("h");
ProfileSummaryInfo PSI = buildPSI(M.get());
EXPECT_TRUE(PSI.hasProfileSummary());
EXPECT_TRUE(PSI.isHotCount(400));
EXPECT_TRUE(PSI.isColdCount(2));
EXPECT_FALSE(PSI.isColdCount(100));
EXPECT_FALSE(PSI.isHotCount(100));
EXPECT_TRUE(PSI.isFunctionEntryHot(F));
EXPECT_FALSE(PSI.isFunctionEntryHot(G));
EXPECT_FALSE(PSI.isFunctionEntryHot(H));
}
TEST_F(ProfileSummaryInfoTest, InstrProf) {
auto M = makeLLVMModule("InstrProf");
Function *F = M->getFunction("f");
ProfileSummaryInfo PSI = buildPSI(M.get());
EXPECT_TRUE(PSI.hasProfileSummary());
EXPECT_TRUE(PSI.hasInstrumentationProfile());
BasicBlock &BB0 = F->getEntryBlock();
BasicBlock *BB1 = BB0.getTerminator()->getSuccessor(0);
BasicBlock *BB2 = BB0.getTerminator()->getSuccessor(1);
BasicBlock *BB3 = BB1->getSingleSuccessor();
BlockFrequencyInfo BFI = buildBFI(*F);
EXPECT_TRUE(PSI.isHotBlock(&BB0, &BFI));
EXPECT_TRUE(PSI.isHotBlock(BB1, &BFI));
EXPECT_FALSE(PSI.isHotBlock(BB2, &BFI));
EXPECT_TRUE(PSI.isHotBlock(BB3, &BFI));
CallSite CS1(BB1->getFirstNonPHI());
auto *CI2 = BB2->getFirstNonPHI();
CallSite CS2(CI2);
EXPECT_TRUE(PSI.isHotCallSite(CS1, &BFI));
EXPECT_FALSE(PSI.isHotCallSite(CS2, &BFI));
// Test that adding an MD_prof metadata with a hot count on CS2 does not
// change its hotness as it has no effect in instrumented profiling.
MDBuilder MDB(M->getContext());
CI2->setMetadata(llvm::LLVMContext::MD_prof, MDB.createBranchWeights({400}));
EXPECT_FALSE(PSI.isHotCallSite(CS2, &BFI));
}
TEST_F(ProfileSummaryInfoTest, SampleProf) {
auto M = makeLLVMModule("SampleProfile");
Function *F = M->getFunction("f");
ProfileSummaryInfo PSI = buildPSI(M.get());
EXPECT_TRUE(PSI.hasProfileSummary());
EXPECT_TRUE(PSI.hasSampleProfile());
BasicBlock &BB0 = F->getEntryBlock();
BasicBlock *BB1 = BB0.getTerminator()->getSuccessor(0);
BasicBlock *BB2 = BB0.getTerminator()->getSuccessor(1);
BasicBlock *BB3 = BB1->getSingleSuccessor();
BlockFrequencyInfo BFI = buildBFI(*F);
EXPECT_TRUE(PSI.isHotBlock(&BB0, &BFI));
EXPECT_TRUE(PSI.isHotBlock(BB1, &BFI));
EXPECT_FALSE(PSI.isHotBlock(BB2, &BFI));
EXPECT_TRUE(PSI.isHotBlock(BB3, &BFI));
CallSite CS1(BB1->getFirstNonPHI());
auto *CI2 = BB2->getFirstNonPHI();
// Manually attach branch weights metadata to the call instruction.
SmallVector<uint32_t, 1> Weights;
Weights.push_back(1000);
MDBuilder MDB(M->getContext());
CI2->setMetadata(LLVMContext::MD_prof, MDB.createBranchWeights(Weights));
CallSite CS2(CI2);
EXPECT_FALSE(PSI.isHotCallSite(CS1, &BFI));
EXPECT_TRUE(PSI.isHotCallSite(CS2, &BFI));
// Test that CS2 is considered hot when it gets an MD_prof metadata with
// weights that exceed the hot count threshold.
CI2->setMetadata(llvm::LLVMContext::MD_prof, MDB.createBranchWeights({400}));
EXPECT_TRUE(PSI.isHotCallSite(CS2, &BFI));
}
} // end anonymous namespace
} // end namespace llvm
|
