Implement more feedback on naming, and finally add some multithreaded unit tests

Author: Jlalond

lldb/include/lldb/Target/Statistics.h

@@ -233,7 +233,7 @@ class SummaryStatisticsCache {
   /// Get the SummaryStatistics object for a given provider name, or insert
   /// if statistics for that provider is not in the map.
   SummaryStatisticsSP
-  GetSummaryStatisticsForProviderName(lldb_private::TypeSummaryImpl &provider) {
+  GetSummaryStatisticsForProvider(lldb_private::TypeSummaryImpl &provider) {
     std::lock_guard<std::mutex> guard(m_map_mutex);
     if (auto iterator = m_summary_stats_map.find(provider.GetName());
          iterator != m_summary_stats_map.end())

lldb/source/Core/ValueObject.cpp

@@ -620,7 +620,7 @@ bool ValueObject::GetSummaryAsCString(TypeSummaryImpl *summary_ptr,
       // Get Shared pointer to the summary statistics container
       SummaryStatisticsSP stats_sp =
           target_sp->GetSummaryStatisticsCache()
-              .GetSummaryStatisticsForProviderName(*summary_ptr);
+              .GetSummaryStatisticsForProvider(*summary_ptr);
 
       // Construct RAII types to time and collect data on summary creation.
       SummaryStatistics::SummaryInvocation invocation(stats_sp);

lldb/source/Target/Target.cpp

@@ -3196,7 +3196,7 @@ void Target::ClearAllLoadedSections() { m_section_load_history.Clear(); }
 
 lldb_private::SummaryStatisticsSP Target::GetSummaryStatisticsSPForProviderName(
     lldb_private::TypeSummaryImpl &summary_provider) {
-  return m_summary_statistics_cache.GetSummaryStatisticsForProviderName(
+  return m_summary_statistics_cache.GetSummaryStatisticsForProvider(
       summary_provider);
 }
 

lldb/unittests/Target/CMakeLists.txt

@@ -11,6 +11,7 @@ add_lldb_unittest(TargetTests
   RegisterFlagsTest.cpp
   RemoteAwarePlatformTest.cpp
   StackFrameRecognizerTest.cpp
+  SummaryStatisticsTest.cpp
   FindFileTest.cpp
 
   LINK_LIBS

lldb/unittests/Target/SummaryStatisticsTest.cpp

@@ -0,0 +1,71 @@
+#include "lldb/DataFormatters/TypeSummary.h"
+#include "lldb/Target/Statistics.h"
+#include "lldb/lldb-forward.h"
+#include "lldb/lldb-private-enumerations.h"
+#include "lldb/lldb-private.h"
+#include "lldb/Utility/Stream.h"
+#include "llvm/Testing/Support/Error.h"
+#include "gtest/gtest.h"
+#include <thread>
+
+using namespace lldb_private;
+using Duration = std::chrono::duration<double>;
+
+class DummySummaryImpl : public lldb_private::TypeSummaryImpl {
+public:
+  DummySummaryImpl(Duration sleepTime):
+    TypeSummaryImpl(TypeSummaryImpl::Kind::eSummaryString, TypeSummaryImpl::Flags()),
+     m_sleepTime(sleepTime) {}
+
+  std::string GetName() override {
+    return "DummySummary";
+  }
+
+  std::string GetSummaryKindName() override {
+    return "dummy";
+  }
+
+  std::string GetDescription() override {
+    return "";
+  } 
+
+  bool FormatObject(ValueObject *valobj, std::string &dest,
+                    const TypeSummaryOptions &options) override {
+    return false;
+  }
+
+  void FakeFormat() {
+    std::this_thread::sleep_for(m_sleepTime);
+  }
+
+private:
+  Duration m_sleepTime;
+};
+
+TEST(MultithreadFormatting, Multithread) {
+  SummaryStatisticsCache statistics_cache;
+  DummySummaryImpl summary(Duration(1));
+  std::vector<std::thread> threads;
+  for (int i = 0; i < 10; ++i) {
+    threads.emplace_back(std::thread([&statistics_cache, &summary]() {
+      auto sp = statistics_cache.GetSummaryStatisticsForProvider(summary);
+      {
+        SummaryStatistics::SummaryInvocation invocation(sp);
+        summary.FakeFormat();
+      }
+    }));
+  }
+
+  for (auto &thread : threads) 
+    thread.join();
+
+  auto sp = statistics_cache.GetSummaryStatisticsForProvider(summary);
+  ASSERT_TRUE(sp->GetDurationReference().get().count() > 10);
+  ASSERT_TRUE(sp->GetSummaryCount() == 10);
+
+  std::string stats_as_json;
+  llvm::raw_string_ostream ss(stats_as_json);
+  ss << sp->ToJSON();
+  ASSERT_THAT(stats_as_json, ::testing::HasSubstr("\"name\":\"DummySummary\""));
+  ASSERT_THAT(stats_as_json, ::testing::HasSubstr("\"type\":\"dummy\""));
+}