1 //===- unittest/ProfileData/SampleProfTest.cpp ------------------*- 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 #include "llvm/ProfileData/SampleProf.h"
10 #include "llvm/ADT/StringMap.h"
11 #include "llvm/ADT/StringRef.h"
12 #include "llvm/IR/LLVMContext.h"
13 #include "llvm/IR/Metadata.h"
14 #include "llvm/IR/Module.h"
15 #include "llvm/ProfileData/SampleProfReader.h"
16 #include "llvm/ProfileData/SampleProfWriter.h"
17 #include "llvm/Support/Casting.h"
18 #include "llvm/Support/ErrorOr.h"
19 #include "llvm/Support/FileSystem.h"
20 #include "llvm/Support/MemoryBuffer.h"
21 #include "llvm/Support/raw_ostream.h"
22 #include "gtest/gtest.h"
23 #include <string>
24 #include <vector>
25 
26 using namespace llvm;
27 using namespace sampleprof;
28 
29 static ::testing::AssertionResult NoError(std::error_code EC) {
30   if (!EC)
31     return ::testing::AssertionSuccess();
32   return ::testing::AssertionFailure() << "error " << EC.value() << ": "
33                                        << EC.message();
34 }
35 
36 namespace {
37 
38 struct SampleProfTest : ::testing::Test {
39   LLVMContext Context;
40   std::unique_ptr<SampleProfileWriter> Writer;
41   std::unique_ptr<SampleProfileReader> Reader;
42 
43   SampleProfTest() : Writer(), Reader() {}
44 
45   void createWriter(SampleProfileFormat Format, StringRef Profile) {
46     std::error_code EC;
47     std::unique_ptr<raw_ostream> OS(
48         new raw_fd_ostream(Profile, EC, sys::fs::OF_None));
49     auto WriterOrErr = SampleProfileWriter::create(OS, Format);
50     ASSERT_TRUE(NoError(WriterOrErr.getError()));
51     Writer = std::move(WriterOrErr.get());
52   }
53 
54   void readProfile(const Module &M, StringRef Profile,
55                    StringRef RemapFile = "") {
56     auto ReaderOrErr = SampleProfileReader::create(
57         std::string(Profile), Context, std::string(RemapFile));
58     ASSERT_TRUE(NoError(ReaderOrErr.getError()));
59     Reader = std::move(ReaderOrErr.get());
60     Reader->collectFuncsFrom(M);
61   }
62 
63   void createRemapFile(SmallVectorImpl<char> &RemapPath, StringRef &RemapFile) {
64     std::error_code EC =
65         llvm::sys::fs::createTemporaryFile("remapfile", "", RemapPath);
66     ASSERT_TRUE(NoError(EC));
67     RemapFile = StringRef(RemapPath.data(), RemapPath.size());
68 
69     std::unique_ptr<raw_fd_ostream> OS(
70         new raw_fd_ostream(RemapFile, EC, sys::fs::OF_None));
71     *OS << R"(
72       # Types 'int' and 'long' are equivalent
73       type i l
74       # Function names 'foo' and 'faux' are equivalent
75       name 3foo 4faux
76     )";
77     OS->close();
78   }
79 
80   // Verify profile summary is consistent in the roundtrip to and from
81   // Metadata. \p AddPartialField is to choose whether the Metadata
82   // contains the IsPartialProfile field which is optional.
83   void verifyProfileSummary(ProfileSummary &Summary, Module &M,
84                             const bool AddPartialField) {
85     LLVMContext &Context = M.getContext();
86     const bool IsPartialProfile = Summary.isPartialProfile();
87     auto VerifySummary = [IsPartialProfile](ProfileSummary &Summary) mutable {
88       ASSERT_EQ(ProfileSummary::PSK_Sample, Summary.getKind());
89       ASSERT_EQ(137392u, Summary.getTotalCount());
90       ASSERT_EQ(8u, Summary.getNumCounts());
91       ASSERT_EQ(4u, Summary.getNumFunctions());
92       ASSERT_EQ(1437u, Summary.getMaxFunctionCount());
93       ASSERT_EQ(60351u, Summary.getMaxCount());
94       ASSERT_EQ(IsPartialProfile, Summary.isPartialProfile());
95 
96       uint32_t Cutoff = 800000;
97       auto Predicate = [&Cutoff](const ProfileSummaryEntry &PE) {
98         return PE.Cutoff == Cutoff;
99       };
100       std::vector<ProfileSummaryEntry> &Details = Summary.getDetailedSummary();
101       auto EightyPerc = find_if(Details, Predicate);
102       Cutoff = 900000;
103       auto NinetyPerc = find_if(Details, Predicate);
104       Cutoff = 950000;
105       auto NinetyFivePerc = find_if(Details, Predicate);
106       Cutoff = 990000;
107       auto NinetyNinePerc = find_if(Details, Predicate);
108       ASSERT_EQ(60000u, EightyPerc->MinCount);
109       ASSERT_EQ(12557u, NinetyPerc->MinCount);
110       ASSERT_EQ(12557u, NinetyFivePerc->MinCount);
111       ASSERT_EQ(610u, NinetyNinePerc->MinCount);
112     };
113     VerifySummary(Summary);
114 
115     // Test that conversion of summary to and from Metadata works.
116     Metadata *MD = Summary.getMD(Context, AddPartialField);
117     ASSERT_TRUE(MD);
118     ProfileSummary *PS = ProfileSummary::getFromMD(MD);
119     ASSERT_TRUE(PS);
120     VerifySummary(*PS);
121     delete PS;
122 
123     // Test that summary can be attached to and read back from module.
124     M.eraseNamedMetadata(M.getOrInsertModuleFlagsMetadata());
125     M.setProfileSummary(MD, ProfileSummary::PSK_Sample);
126     MD = M.getProfileSummary(/* IsCS */ false);
127     ASSERT_TRUE(MD);
128     PS = ProfileSummary::getFromMD(MD);
129     ASSERT_TRUE(PS);
130     VerifySummary(*PS);
131     delete PS;
132   }
133 
134   void testRoundTrip(SampleProfileFormat Format, bool Remap, bool UseMD5) {
135     SmallVector<char, 128> ProfilePath;
136     ASSERT_TRUE(NoError(llvm::sys::fs::createTemporaryFile("profile", "", ProfilePath)));
137     StringRef Profile(ProfilePath.data(), ProfilePath.size());
138     createWriter(Format, Profile);
139     if (Format == SampleProfileFormat::SPF_Ext_Binary && UseMD5)
140       static_cast<SampleProfileWriterExtBinary *>(Writer.get())->setUseMD5();
141 
142     StringRef FooName("_Z3fooi");
143     FunctionSamples FooSamples;
144     FooSamples.setName(FooName);
145     FooSamples.addTotalSamples(7711);
146     FooSamples.addHeadSamples(610);
147     FooSamples.addBodySamples(1, 0, 610);
148     FooSamples.addBodySamples(2, 0, 600);
149     FooSamples.addBodySamples(4, 0, 60000);
150     FooSamples.addBodySamples(8, 0, 60351);
151     FooSamples.addBodySamples(10, 0, 605);
152 
153     StringRef BarName("_Z3bari");
154     FunctionSamples BarSamples;
155     BarSamples.setName(BarName);
156     BarSamples.addTotalSamples(20301);
157     BarSamples.addHeadSamples(1437);
158     BarSamples.addBodySamples(1, 0, 1437);
159     // Test how reader/writer handles unmangled names.
160     StringRef MconstructName("_M_construct<char *>");
161     StringRef StringviewName("string_view<std::allocator<char> >");
162     BarSamples.addCalledTargetSamples(1, 0, MconstructName, 1000);
163     BarSamples.addCalledTargetSamples(1, 0, StringviewName, 437);
164 
165     StringRef BazName("_Z3bazi");
166     FunctionSamples BazSamples;
167     BazSamples.setName(BazName);
168     BazSamples.addTotalSamples(12557);
169     BazSamples.addHeadSamples(1257);
170     BazSamples.addBodySamples(1, 0, 12557);
171 
172     StringRef BooName("_Z3booi");
173     FunctionSamples BooSamples;
174     BooSamples.setName(BooName);
175     BooSamples.addTotalSamples(1232);
176     BooSamples.addHeadSamples(1);
177     BooSamples.addBodySamples(1, 0, 1232);
178 
179     StringMap<FunctionSamples> Profiles;
180     Profiles[FooName] = std::move(FooSamples);
181     Profiles[BarName] = std::move(BarSamples);
182     Profiles[BazName] = std::move(BazSamples);
183     Profiles[BooName] = std::move(BooSamples);
184 
185     Module M("my_module", Context);
186     FunctionType *fn_type =
187         FunctionType::get(Type::getVoidTy(Context), {}, false);
188 
189     SmallVector<char, 128> RemapPath;
190     StringRef RemapFile;
191     if (Remap) {
192       createRemapFile(RemapPath, RemapFile);
193       FooName = "_Z4fauxi";
194       BarName = "_Z3barl";
195     }
196 
197     M.getOrInsertFunction(FooName, fn_type);
198     M.getOrInsertFunction(BarName, fn_type);
199     M.getOrInsertFunction(BooName, fn_type);
200 
201     ProfileSymbolList List;
202     if (Format == SampleProfileFormat::SPF_Ext_Binary) {
203       List.add("zoo", true);
204       List.add("moo", true);
205     }
206     Writer->setProfileSymbolList(&List);
207 
208     std::error_code EC;
209     EC = Writer->write(Profiles);
210     ASSERT_TRUE(NoError(EC));
211 
212     Writer->getOutputStream().flush();
213 
214     readProfile(M, Profile, RemapFile);
215     EC = Reader->read();
216     ASSERT_TRUE(NoError(EC));
217 
218     if (Format == SampleProfileFormat::SPF_Ext_Binary) {
219       std::unique_ptr<ProfileSymbolList> ReaderList =
220           Reader->getProfileSymbolList();
221       ReaderList->contains("zoo");
222       ReaderList->contains("moo");
223     }
224 
225     FunctionSamples *ReadFooSamples = Reader->getSamplesFor(FooName);
226     ASSERT_TRUE(ReadFooSamples != nullptr);
227     if (!UseMD5) {
228       ASSERT_EQ("_Z3fooi", ReadFooSamples->getName());
229     }
230     ASSERT_EQ(7711u, ReadFooSamples->getTotalSamples());
231     ASSERT_EQ(610u, ReadFooSamples->getHeadSamples());
232 
233     FunctionSamples *ReadBarSamples = Reader->getSamplesFor(BarName);
234     ASSERT_TRUE(ReadBarSamples != nullptr);
235     if (!UseMD5) {
236       ASSERT_EQ("_Z3bari", ReadBarSamples->getName());
237     }
238     ASSERT_EQ(20301u, ReadBarSamples->getTotalSamples());
239     ASSERT_EQ(1437u, ReadBarSamples->getHeadSamples());
240     ErrorOr<SampleRecord::CallTargetMap> CTMap =
241         ReadBarSamples->findCallTargetMapAt(1, 0);
242     ASSERT_FALSE(CTMap.getError());
243 
244     // Because _Z3bazi is not defined in module M, expect _Z3bazi's profile
245     // is not loaded when the profile is ExtBinary or Compact format because
246     // these formats support loading function profiles on demand.
247     FunctionSamples *ReadBazSamples = Reader->getSamplesFor(BazName);
248     if (Format == SampleProfileFormat::SPF_Ext_Binary ||
249         Format == SampleProfileFormat::SPF_Compact_Binary) {
250       ASSERT_TRUE(ReadBazSamples == nullptr);
251       ASSERT_EQ(3u, Reader->getProfiles().size());
252     } else {
253       ASSERT_TRUE(ReadBazSamples != nullptr);
254       ASSERT_EQ(12557u, ReadBazSamples->getTotalSamples());
255       ASSERT_EQ(4u, Reader->getProfiles().size());
256     }
257 
258     FunctionSamples *ReadBooSamples = Reader->getSamplesFor(BooName);
259     ASSERT_TRUE(ReadBooSamples != nullptr);
260     ASSERT_EQ(1232u, ReadBooSamples->getTotalSamples());
261 
262     std::string MconstructGUID;
263     StringRef MconstructRep =
264         getRepInFormat(MconstructName, UseMD5, MconstructGUID);
265     std::string StringviewGUID;
266     StringRef StringviewRep =
267         getRepInFormat(StringviewName, UseMD5, StringviewGUID);
268     ASSERT_EQ(1000u, CTMap.get()[MconstructRep]);
269     ASSERT_EQ(437u, CTMap.get()[StringviewRep]);
270 
271 
272     ProfileSummary &Summary = Reader->getSummary();
273     Summary.setPartialProfile(true);
274     verifyProfileSummary(Summary, M, true);
275 
276     Summary.setPartialProfile(false);
277     verifyProfileSummary(Summary, M, true);
278 
279     Summary.setPartialProfile(false);
280     verifyProfileSummary(Summary, M, false);
281   }
282 
283   void addFunctionSamples(StringMap<FunctionSamples> *Smap, const char *Fname,
284                           uint64_t TotalSamples, uint64_t HeadSamples) {
285     StringRef Name(Fname);
286     FunctionSamples FcnSamples;
287     FcnSamples.setName(Name);
288     FcnSamples.addTotalSamples(TotalSamples);
289     FcnSamples.addHeadSamples(HeadSamples);
290     FcnSamples.addBodySamples(1, 0, HeadSamples);
291     (*Smap)[Name] = FcnSamples;
292   }
293 
294   StringMap<FunctionSamples> setupFcnSamplesForElisionTest(StringRef Policy) {
295     StringMap<FunctionSamples> Smap;
296     addFunctionSamples(&Smap, "foo", uint64_t(20301), uint64_t(1437));
297     if (Policy == "" || Policy == "all")
298       return Smap;
299     addFunctionSamples(&Smap, "foo.bar", uint64_t(20303), uint64_t(1439));
300     if (Policy == "selected")
301       return Smap;
302     addFunctionSamples(&Smap, "foo.llvm.2465", uint64_t(20305), uint64_t(1441));
303     return Smap;
304   }
305 
306   void createFunctionWithSampleProfileElisionPolicy(Module *M,
307                                                     const char *Fname,
308                                                     StringRef Policy) {
309     FunctionType *FnType =
310         FunctionType::get(Type::getVoidTy(Context), {}, false);
311     auto Inserted = M->getOrInsertFunction(Fname, FnType);
312     auto Fcn = cast<Function>(Inserted.getCallee());
313     if (Policy != "")
314       Fcn->addFnAttr("sample-profile-suffix-elision-policy", Policy);
315   }
316 
317   void setupModuleForElisionTest(Module *M, StringRef Policy) {
318     createFunctionWithSampleProfileElisionPolicy(M, "foo", Policy);
319     createFunctionWithSampleProfileElisionPolicy(M, "foo.bar", Policy);
320     createFunctionWithSampleProfileElisionPolicy(M, "foo.llvm.2465", Policy);
321   }
322 
323   void testSuffixElisionPolicy(SampleProfileFormat Format, StringRef Policy,
324                                const StringMap<uint64_t> &Expected) {
325     SmallVector<char, 128> ProfilePath;
326     std::error_code EC;
327     EC = llvm::sys::fs::createTemporaryFile("profile", "", ProfilePath);
328     ASSERT_TRUE(NoError(EC));
329     StringRef ProfileFile(ProfilePath.data(), ProfilePath.size());
330 
331     Module M("my_module", Context);
332     setupModuleForElisionTest(&M, Policy);
333     StringMap<FunctionSamples> ProfMap = setupFcnSamplesForElisionTest(Policy);
334 
335     // write profile
336     createWriter(Format, ProfileFile);
337     EC = Writer->write(ProfMap);
338     ASSERT_TRUE(NoError(EC));
339     Writer->getOutputStream().flush();
340 
341     // read profile
342     readProfile(M, ProfileFile);
343     EC = Reader->read();
344     ASSERT_TRUE(NoError(EC));
345 
346     for (auto I = Expected.begin(); I != Expected.end(); ++I) {
347       uint64_t Esamples = uint64_t(-1);
348       FunctionSamples *Samples = Reader->getSamplesFor(I->getKey());
349       if (Samples != nullptr)
350         Esamples = Samples->getTotalSamples();
351       ASSERT_EQ(I->getValue(), Esamples);
352     }
353   }
354 };
355 
356 TEST_F(SampleProfTest, roundtrip_text_profile) {
357   testRoundTrip(SampleProfileFormat::SPF_Text, false, false);
358 }
359 
360 TEST_F(SampleProfTest, roundtrip_raw_binary_profile) {
361   testRoundTrip(SampleProfileFormat::SPF_Binary, false, false);
362 }
363 
364 TEST_F(SampleProfTest, roundtrip_compact_binary_profile) {
365   testRoundTrip(SampleProfileFormat::SPF_Compact_Binary, false, true);
366 }
367 
368 TEST_F(SampleProfTest, roundtrip_ext_binary_profile) {
369   testRoundTrip(SampleProfileFormat::SPF_Ext_Binary, false, false);
370 }
371 
372 TEST_F(SampleProfTest, roundtrip_md5_ext_binary_profile) {
373   testRoundTrip(SampleProfileFormat::SPF_Ext_Binary, false, true);
374 }
375 
376 TEST_F(SampleProfTest, remap_text_profile) {
377   testRoundTrip(SampleProfileFormat::SPF_Text, true, false);
378 }
379 
380 TEST_F(SampleProfTest, remap_raw_binary_profile) {
381   testRoundTrip(SampleProfileFormat::SPF_Binary, true, false);
382 }
383 
384 TEST_F(SampleProfTest, remap_ext_binary_profile) {
385   testRoundTrip(SampleProfileFormat::SPF_Ext_Binary, true, false);
386 }
387 
388 TEST_F(SampleProfTest, sample_overflow_saturation) {
389   const uint64_t Max = std::numeric_limits<uint64_t>::max();
390   sampleprof_error Result;
391 
392   FunctionSamples FooSamples;
393   Result = FooSamples.addTotalSamples(1);
394   ASSERT_EQ(Result, sampleprof_error::success);
395 
396   Result = FooSamples.addHeadSamples(1);
397   ASSERT_EQ(Result, sampleprof_error::success);
398 
399   Result = FooSamples.addBodySamples(10, 0, 1);
400   ASSERT_EQ(Result, sampleprof_error::success);
401 
402   Result = FooSamples.addTotalSamples(Max);
403   ASSERT_EQ(Result, sampleprof_error::counter_overflow);
404   ASSERT_EQ(FooSamples.getTotalSamples(), Max);
405 
406   Result = FooSamples.addHeadSamples(Max);
407   ASSERT_EQ(Result, sampleprof_error::counter_overflow);
408   ASSERT_EQ(FooSamples.getHeadSamples(), Max);
409 
410   Result = FooSamples.addBodySamples(10, 0, Max);
411   ASSERT_EQ(Result, sampleprof_error::counter_overflow);
412   ErrorOr<uint64_t> BodySamples = FooSamples.findSamplesAt(10, 0);
413   ASSERT_FALSE(BodySamples.getError());
414   ASSERT_EQ(BodySamples.get(), Max);
415 }
416 
417 TEST_F(SampleProfTest, default_suffix_elision_text) {
418   // Default suffix elision policy: strip everything after first dot.
419   // This implies that all suffix variants will map to "foo", so
420   // we don't expect to see any entries for them in the sample
421   // profile.
422   StringMap<uint64_t> Expected;
423   Expected["foo"] = uint64_t(20301);
424   Expected["foo.bar"] = uint64_t(-1);
425   Expected["foo.llvm.2465"] = uint64_t(-1);
426   testSuffixElisionPolicy(SampleProfileFormat::SPF_Text, "", Expected);
427 }
428 
429 TEST_F(SampleProfTest, default_suffix_elision_compact_binary) {
430   // Default suffix elision policy: strip everything after first dot.
431   // This implies that all suffix variants will map to "foo", so
432   // we don't expect to see any entries for them in the sample
433   // profile.
434   StringMap<uint64_t> Expected;
435   Expected["foo"] = uint64_t(20301);
436   Expected["foo.bar"] = uint64_t(-1);
437   Expected["foo.llvm.2465"] = uint64_t(-1);
438   testSuffixElisionPolicy(SampleProfileFormat::SPF_Compact_Binary, "",
439                           Expected);
440 }
441 
442 TEST_F(SampleProfTest, selected_suffix_elision_text) {
443   // Profile is created and searched using the "selected"
444   // suffix elision policy: we only strip a .XXX suffix if
445   // it matches a pattern known to be generated by the compiler
446   // (e.g. ".llvm.<digits>").
447   StringMap<uint64_t> Expected;
448   Expected["foo"] = uint64_t(20301);
449   Expected["foo.bar"] = uint64_t(20303);
450   Expected["foo.llvm.2465"] = uint64_t(-1);
451   testSuffixElisionPolicy(SampleProfileFormat::SPF_Text, "selected", Expected);
452 }
453 
454 TEST_F(SampleProfTest, selected_suffix_elision_compact_binary) {
455   // Profile is created and searched using the "selected"
456   // suffix elision policy: we only strip a .XXX suffix if
457   // it matches a pattern known to be generated by the compiler
458   // (e.g. ".llvm.<digits>").
459   StringMap<uint64_t> Expected;
460   Expected["foo"] = uint64_t(20301);
461   Expected["foo.bar"] = uint64_t(20303);
462   Expected["foo.llvm.2465"] = uint64_t(-1);
463   testSuffixElisionPolicy(SampleProfileFormat::SPF_Compact_Binary, "selected",
464                           Expected);
465 }
466 
467 TEST_F(SampleProfTest, none_suffix_elision_text) {
468   // Profile is created and searched using the "none"
469   // suffix elision policy: no stripping of suffixes at all.
470   // Here we expect to see all variants in the profile.
471   StringMap<uint64_t> Expected;
472   Expected["foo"] = uint64_t(20301);
473   Expected["foo.bar"] = uint64_t(20303);
474   Expected["foo.llvm.2465"] = uint64_t(20305);
475   testSuffixElisionPolicy(SampleProfileFormat::SPF_Text, "none", Expected);
476 }
477 
478 TEST_F(SampleProfTest, none_suffix_elision_compact_binary) {
479   // Profile is created and searched using the "none"
480   // suffix elision policy: no stripping of suffixes at all.
481   // Here we expect to see all variants in the profile.
482   StringMap<uint64_t> Expected;
483   Expected["foo"] = uint64_t(20301);
484   Expected["foo.bar"] = uint64_t(20303);
485   Expected["foo.llvm.2465"] = uint64_t(20305);
486   testSuffixElisionPolicy(SampleProfileFormat::SPF_Compact_Binary, "none",
487                           Expected);
488 }
489 
490 } // end anonymous namespace
491