Interface to get/set profile summary metadata to module

[eraman]

Summary

This is the first in a series of patches to remove MaxFunctionCount metadata from module and add profile summary metadata instead.

[davidxl]

Perhaps add a unit test in unittest/ProfileData/InstrProfTest.cpp?

[dnovillo]

Needs a test. Otherwise, LGTM. Thanks.

[eraman]

Added unit tests.

llvm/trunk/include/llvm/IR/Module.h

/// @{
 
   /// \brief Returns the PIC level (small or large model)
   PICLevel::Level getPICLevel() const;
 
   /// \brief Set the PIC level (small or large model)
   void setPICLevel(PICLevel::Level PL);
 /// @}
 
-  /// @name Utility functions for querying and setting PGO counts
+  /// @name Utility functions for querying and setting PGO summary
   /// @{
 
   /// \brief Set maximum function count in PGO mode
   void setMaximumFunctionCount(uint64_t);
 
   /// \brief Returns maximum function count in PGO mode
   Optional<uint64_t> getMaximumFunctionCount();
+
+  /// \brief Attach profile summary metadata to this module.
+  void setProfileSummary(Metadata *M);
+
+  /// \brief Returns profile summary metadata
+  Metadata *getProfileSummary();
   /// @}
 };
 
 /// An raw_ostream inserter for modules.
 inline raw_ostream &operator<<(raw_ostream &O, const Module &M) {
   M.print(O, nullptr);
   return O;
 }

llvm/trunk/lib/IR/Module.cpp

 
 Optional<uint64_t> Module::getMaximumFunctionCount() {
   auto *Val =
       cast_or_null<ConstantAsMetadata>(getModuleFlag("MaxFunctionCount"));
   if (!Val)
     return None;
   return cast<ConstantInt>(Val->getValue())->getZExtValue();
 }
+
+void Module::setProfileSummary(Metadata *M) {
+  addModuleFlag(ModFlagBehavior::Error, "ProfileSummary", M);
+}
+
+Metadata *Module::getProfileSummary() {
+  return getModuleFlag("ProfileSummary");
+}

llvm/trunk/unittests/ProfileData/InstrProfTest.cpp

auto NinetyNinePerc =
         std::find_if(Details.begin(), Details.end(), Predicate);
     ASSERT_EQ(576460752303423488U, EightyPerc->MinCount);
     ASSERT_EQ(288230376151711744U, NinetyPerc->MinCount);
     ASSERT_EQ(288230376151711744U, NinetyFivePerc->MinCount);
     ASSERT_EQ(72057594037927936U, NinetyNinePerc->MinCount);
   };
   InstrProfSummary &PS = Reader->getSummary();
   VerifySummary(PS);
+
+  // Test that conversion of summary to and from Metadata works.
   Metadata *MD = PS.getMD(getGlobalContext());
   ASSERT_TRUE(MD);
   ProfileSummary *PSFromMD = ProfileSummary::getFromMD(MD);
   ASSERT_TRUE(PSFromMD);
   ASSERT_TRUE(isa<InstrProfSummary>(PSFromMD));
   InstrProfSummary *IPS = cast<InstrProfSummary>(PSFromMD);
   VerifySummary(*IPS);
   delete IPS;
+
+  // Test that summary can be attached to and read back from module.
+  Module M("my_module", getGlobalContext());
+  M.setProfileSummary(MD);
+  MD = M.getProfileSummary();
+  ASSERT_TRUE(MD);
+  PSFromMD = ProfileSummary::getFromMD(MD);
+  ASSERT_TRUE(PSFromMD);
+  ASSERT_TRUE(isa<InstrProfSummary>(PSFromMD));
+  IPS = cast<InstrProfSummary>(PSFromMD);
+  VerifySummary(*IPS);
+  delete IPS;
 }
 
 TEST_P(MaybeSparseInstrProfTest, get_icall_data_read_write) {
   InstrProfRecord Record1("caller", 0x1234, {1, 2});
   InstrProfRecord Record2("callee1", 0x1235, {3, 4});
   InstrProfRecord Record3("callee2", 0x1235, {3, 4});
   InstrProfRecord Record4("callee3", 0x1235, {3, 4});
 

llvm/trunk/unittests/ProfileData/SampleProfTest.cpp

auto VerifySummary = [](SampleProfileSummary &Summary) mutable {
       ASSERT_EQ(60000u, NinetyPerc->MinCount);
       ASSERT_EQ(60000u, NinetyFivePerc->MinCount);
       ASSERT_EQ(610u, NinetyNinePerc->MinCount);
     };
 
     SampleProfileSummary &Summary = Reader->getSummary();
     VerifySummary(Summary);
 
+    // Test that conversion of summary to and from Metadata works.
     Metadata *MD = Summary.getMD(getGlobalContext());
     ASSERT_TRUE(MD);
     ProfileSummary *PS = ProfileSummary::getFromMD(MD);
     ASSERT_TRUE(PS);
     ASSERT_TRUE(isa<SampleProfileSummary>(PS));
     SampleProfileSummary *SPS = cast<SampleProfileSummary>(PS);
     VerifySummary(*SPS);
     delete SPS;
+
+    // Test that summary can be attached to and read back from module.
+    Module M("my_module", getGlobalContext());
+    M.setProfileSummary(MD);
+    MD = M.getProfileSummary();
+    ASSERT_TRUE(MD);
+    PS = ProfileSummary::getFromMD(MD);
+    ASSERT_TRUE(PS);
+    ASSERT_TRUE(isa<SampleProfileSummary>(PS));
+    SPS = cast<SampleProfileSummary>(PS);
+    VerifySummary(*SPS);
+    delete SPS;
   }
 };
 
 TEST_F(SampleProfTest, roundtrip_text_profile) {
   testRoundTrip(SampleProfileFormat::SPF_Text);
 }
 
 TEST_F(SampleProfTest, roundtrip_binary_profile) {