[LLDB][Data Formatters] Calculate average and total time for summary providers within lldb #102708

Jlalond · 2024-08-10T00:36:15Z

This PR adds a statistics provider cache, which allows an individual target to keep a rolling tally of it's total time and number of invocations for a given summary provider. This information is then available in statistics dump to help slow summary providers, and gleam more into insight into LLDB's time use.

llvmbot · 2024-08-10T00:36:43Z

@llvm/pr-subscribers-lldb

Author: Jacob Lalonde (Jlalond)

Changes

This PR adds a statistics provider cache, which allows an individual target to keep a rolling tally of it's total time and number of invocations for a given summary provider. This information is then available in statistics dump to help slow summary providers, and gleam more into insight into LLDB's time use.

Full diff: https://github.com/llvm/llvm-project/pull/102708.diff

8 Files Affected:

(modified) lldb/include/lldb/Target/Statistics.h (+80)
(modified) lldb/include/lldb/Target/Target.h (+5)
(modified) lldb/source/Core/ValueObject.cpp (+10-1)
(modified) lldb/source/Target/Statistics.cpp (+22)
(modified) lldb/source/Target/Target.cpp (+8)
(modified) lldb/test/API/commands/statistics/basic/Makefile (+1-1)
(modified) lldb/test/API/commands/statistics/basic/TestStats.py (+25-2)
(renamed) lldb/test/API/commands/statistics/basic/main.cpp (+7-1)

diff --git a/lldb/include/lldb/Target/Statistics.h b/lldb/include/lldb/Target/Statistics.h
index 35bd7f8a66e055..06ca5c7923f747 100644
--- a/lldb/include/lldb/Target/Statistics.h
+++ b/lldb/include/lldb/Target/Statistics.h
@@ -16,6 +16,7 @@
 #include "llvm/Support/JSON.h"
 #include <atomic>
 #include <chrono>
+#include <mutex>
 #include <optional>
 #include <ratio>
 #include <string>
@@ -25,6 +26,7 @@ namespace lldb_private {
 
 using StatsClock = std::chrono::high_resolution_clock;
 using StatsTimepoint = std::chrono::time_point<StatsClock>;
+using Duration = std::chrono::duration<double>;
 
 class StatsDuration {
 public:
@@ -174,6 +176,83 @@ struct StatisticsOptions {
   std::optional<bool> m_include_transcript;
 };
 
+/// A class that represents statistics about a TypeSummaryProviders invocations
+class SummaryStatistics {
+public:
+  SummaryStatistics() = default;
+  SummaryStatistics(lldb_private::ConstString name) : 
+    m_total_time(), m_name(name), m_summary_count(0) {}
+
+  SummaryStatistics(const SummaryStatistics &&rhs)
+      : m_total_time(), m_name(rhs.m_name), m_summary_count(rhs.m_summary_count.load(std::memory_order_relaxed)) {}
+
+  lldb_private::ConstString GetName() const { return m_name; };
+  double GetAverageTime() const {
+    return m_total_time.get().count() / m_summary_count.load(std::memory_order_relaxed);
+  }
+
+  double GetTotalTime() const {
+    return m_total_time.get().count();
+  }
+
+  uint64_t GetSummaryCount() const {
+    return m_summary_count.load(std::memory_order_relaxed);
+  }
+
+  StatsDuration& GetDurationReference() {
+    return m_total_time;
+  }
+
+  llvm::json::Value ToJSON() const;
+
+  // Basic RAII class to increment the summary count when the call is complete.
+  // In the future this can be extended to collect information about the 
+  // elapsed time for a single request.
+  class SummaryInvocation {
+  public:
+    SummaryInvocation(SummaryStatistics &summary) : m_summary(summary) {}
+    ~SummaryInvocation() {
+      m_summary.OnInvoked();
+    }
+  private:
+    SummaryStatistics &m_summary;
+  };
+
+private:
+  /// Called when Summary Invocation is destructed.
+  void OnInvoked() {
+    m_summary_count.fetch_add(1, std::memory_order_relaxed);
+  }
+
+  lldb_private::StatsDuration m_total_time;
+  lldb_private::ConstString m_name;
+  std::atomic<uint64_t> m_summary_count;
+};
+
+/// A class that wraps a std::map of SummaryStatistics objects behind a mutex.
+class SummaryStatisticsCache {
+public:
+  SummaryStatisticsCache() = default;
+  /// Get the SummaryStatistics object for a given provider name, or insert
+  /// if statistics for that provider is not in the map.
+  lldb_private::SummaryStatistics &GetSummaryStatisticsForProviderName(lldb_private::ConstString summary_provider_name) {
+    m_map_mutex.lock();
+    if (m_summary_stats_map.count(summary_provider_name) == 0) {
+      m_summary_stats_map.emplace(summary_provider_name, SummaryStatistics(summary_provider_name));
+    }
+
+    SummaryStatistics &summary_stats = m_summary_stats_map.at(summary_provider_name);
+    m_map_mutex.unlock();
+    return summary_stats;
+  }
+
+  llvm::json::Value ToJSON();
+
+private:
+  std::map<lldb_private::ConstString, lldb_private::SummaryStatistics> m_summary_stats_map;
+  std::mutex m_map_mutex;
+};
+
 /// A class that represents statistics for a since lldb_private::Target.
 class TargetStats {
 public:
@@ -198,6 +277,7 @@ class TargetStats {
   StatsSuccessFail m_frame_var{"frameVariable"};
   std::vector<intptr_t> m_module_identifiers;
   uint32_t m_source_map_deduce_count = 0;
+  SummaryStatisticsCache m_summary_stats_cache;
   void CollectStats(Target &target);
 };
 
diff --git a/lldb/include/lldb/Target/Target.h b/lldb/include/lldb/Target/Target.h
index 119dff4d498199..ae1ea43c01003b 100644
--- a/lldb/include/lldb/Target/Target.h
+++ b/lldb/include/lldb/Target/Target.h
@@ -258,6 +258,7 @@ class TargetProperties : public Properties {
 
   bool GetDebugUtilityExpression() const;
 
+
 private:
   std::optional<bool>
   GetExperimentalPropertyValue(size_t prop_idx,
@@ -1221,6 +1222,9 @@ class Target : public std::enable_shared_from_this<Target>,
 
   void ClearAllLoadedSections();
 
+  lldb_private::SummaryStatistics& GetSummaryStatisticsForProvider(lldb_private::ConstString summary_provider_name);
+  lldb_private::SummaryStatisticsCache& GetSummaryStatisticsCache();
+
   /// Set the \a Trace object containing processor trace information of this
   /// target.
   ///
@@ -1554,6 +1558,7 @@ class Target : public std::enable_shared_from_this<Target>,
   std::string m_label;
   ModuleList m_images; ///< The list of images for this process (shared
                        /// libraries and anything dynamically loaded).
+  SummaryStatisticsCache m_summary_statistics_cache;
   SectionLoadHistory m_section_load_history;
   BreakpointList m_breakpoint_list;
   BreakpointList m_internal_breakpoint_list;
diff --git a/lldb/source/Core/ValueObject.cpp b/lldb/source/Core/ValueObject.cpp
index 8f72efc2299b4f..8e6ff41c08539f 100644
--- a/lldb/source/Core/ValueObject.cpp
+++ b/lldb/source/Core/ValueObject.cpp
@@ -615,7 +615,16 @@ bool ValueObject::GetSummaryAsCString(TypeSummaryImpl *summary_ptr,
       m_synthetic_value->UpdateValueIfNeeded(); // the summary might depend on
                                                 // the synthetic children being
                                                 // up-to-date (e.g. ${svar%#})
-    summary_ptr->FormatObject(this, destination, actual_options);
+    SummaryStatistics &summary_stats = GetExecutionContextRef()
+                                        .GetProcessSP()
+                                        ->GetTarget()
+                                        .GetSummaryStatisticsForProvider(GetTypeName());
+    /// Construct RAII types to time and collect data on summary creation.
+    SummaryStatistics::SummaryInvocation summary_inv(summary_stats);
+    {
+      ElapsedTime elapsed(summary_stats.GetDurationReference());
+      summary_ptr->FormatObject(this, destination, actual_options);
+    }
   }
   m_flags.m_is_getting_summary = false;
   return !destination.empty();
diff --git a/lldb/source/Target/Statistics.cpp b/lldb/source/Target/Statistics.cpp
index 583d1524881fc3..bcb8fdbca42a3c 100644
--- a/lldb/source/Target/Statistics.cpp
+++ b/lldb/source/Target/Statistics.cpp
@@ -192,6 +192,8 @@ TargetStats::ToJSON(Target &target,
   }
   target_metrics_json.try_emplace("sourceMapDeduceCount",
                                   m_source_map_deduce_count);
+  target_metrics_json.try_emplace("summaryProviderStatistics", 
+                                  target.GetSummaryStatisticsCache().ToJSON());
   return target_metrics_json;
 }
 
@@ -408,3 +410,23 @@ llvm::json::Value DebuggerStats::ReportStatistics(
 
   return std::move(global_stats);
 }
+
+llvm::json::Value SummaryStatistics::ToJSON() const {
+  json::Object body {{
+      {"invocationCount", GetSummaryCount()},
+      {"totalTime", GetTotalTime()},
+      {"averageTime", GetAverageTime()}
+    }};
+  return json::Object{{GetName().AsCString(), std::move(body)}};
+}
+
+
+json::Value SummaryStatisticsCache::ToJSON() {
+  m_map_mutex.lock();
+  json::Array json_summary_stats;
+  for (const auto &summary_stat : m_summary_stats_map)
+    json_summary_stats.emplace_back(summary_stat.second.ToJSON());
+    
+  m_map_mutex.unlock();
+  return json_summary_stats;
+}
diff --git a/lldb/source/Target/Target.cpp b/lldb/source/Target/Target.cpp
index 129683c43f0c1a..834d48763bdff8 100644
--- a/lldb/source/Target/Target.cpp
+++ b/lldb/source/Target/Target.cpp
@@ -3193,6 +3193,14 @@ bool Target::SetSectionUnloaded(const lldb::SectionSP &section_sp,
 
 void Target::ClearAllLoadedSections() { m_section_load_history.Clear(); }
 
+lldb_private::SummaryStatistics& Target::GetSummaryStatisticsForProvider(lldb_private::ConstString summary_provider_name) {
+  return m_summary_statistics_cache.GetSummaryStatisticsForProviderName(summary_provider_name);
+}
+
+lldb_private::SummaryStatisticsCache& Target::GetSummaryStatisticsCache() {
+  return m_summary_statistics_cache;
+}
+
 void Target::SaveScriptedLaunchInfo(lldb_private::ProcessInfo &process_info) {
   if (process_info.IsScriptedProcess()) {
     // Only copy scripted process launch options.
diff --git a/lldb/test/API/commands/statistics/basic/Makefile b/lldb/test/API/commands/statistics/basic/Makefile
index c9319d6e6888a4..3d0b98f13f3d7b 100644
--- a/lldb/test/API/commands/statistics/basic/Makefile
+++ b/lldb/test/API/commands/statistics/basic/Makefile
@@ -1,2 +1,2 @@
-C_SOURCES := main.c
+CXX_SOURCES := main.cpp
 include Makefile.rules
diff --git a/lldb/test/API/commands/statistics/basic/TestStats.py b/lldb/test/API/commands/statistics/basic/TestStats.py
index a8ac60090a760d..85e76e526849ab 100644
--- a/lldb/test/API/commands/statistics/basic/TestStats.py
+++ b/lldb/test/API/commands/statistics/basic/TestStats.py
@@ -81,7 +81,7 @@ def get_command_stats(self, debug_stats):
     def test_expressions_frame_var_counts(self):
         self.build()
         lldbutil.run_to_source_breakpoint(
-            self, "// break here", lldb.SBFileSpec("main.c")
+            self, "// break here", lldb.SBFileSpec("main.cpp")
         )
 
         self.expect("expr patatino", substrs=["27"])
@@ -224,7 +224,7 @@ def test_default_with_run(self):
         self.build()
         target = self.createTestTarget()
         lldbutil.run_to_source_breakpoint(
-            self, "// break here", lldb.SBFileSpec("main.c")
+            self, "// break here", lldb.SBFileSpec("main.cpp")
         )
         debug_stats = self.get_stats()
         debug_stat_keys = [
@@ -250,6 +250,7 @@ def test_default_with_run(self):
             "launchOrAttachTime",
             "moduleIdentifiers",
             "targetCreateTime",
+            "summaryProviderStatistics"
         ]
         self.verify_keys(stats, '"stats"', keys_exist, None)
         self.assertGreater(stats["firstStopTime"], 0.0)
@@ -447,6 +448,7 @@ def test_breakpoints(self):
             "targetCreateTime",
             "moduleIdentifiers",
             "totalBreakpointResolveTime",
+            "summaryProviderStatistics"
         ]
         self.verify_keys(target_stats, '"stats"', keys_exist, None)
         self.assertGreater(target_stats["totalBreakpointResolveTime"], 0.0)
@@ -918,3 +920,24 @@ def test_order_of_options_do_not_matter(self):
                 debug_stats_1,
                 f"The order of options '{options[0]}' and '{options[1]}' should not matter",
             )
+    
+    def test_summary_statistics_providers(self):
+        """
+        Test summary timing statistics is included in statistics dump when 
+        a type with a summary provider exists, and is evaluated.
+        """
+
+        self.build()
+        target = self.createTestTarget()
+        lldbutil.run_to_source_breakpoint(
+            self, "// stop here", lldb.SBFileSpec("main.cpp")
+        )
+        self.expect("frame var", substrs=["hello world"])
+        stats = self.get_target_stats(self.get_stats())
+        self.assertIn("summaryProviderStatistics", stats)
+        summary_providers = stats["summaryProviderStatistics"]
+        # We don't want to take a dependency on the type name, so we just look
+        # for string and that it was called once.
+        summary_provider_str = str(summary_providers)
+        self.assertIn("string", summary_provider_str)
+        self.assertIn("'invocationCount': 1", summary_provider_str)
diff --git a/lldb/test/API/commands/statistics/basic/main.c b/lldb/test/API/commands/statistics/basic/main.cpp
similarity index 52%
rename from lldb/test/API/commands/statistics/basic/main.c
rename to lldb/test/API/commands/statistics/basic/main.cpp
index 2c5b4f5f098ee4..3e3f34421eca30 100644
--- a/lldb/test/API/commands/statistics/basic/main.c
+++ b/lldb/test/API/commands/statistics/basic/main.cpp
@@ -1,7 +1,13 @@
 // Test that the lldb command `statistics` works.
+#include <string>
+
+void foo() {
+  std::string str = "hello world";
+  str += "\n"; // stop here
+}
 
 int main(void) {
   int patatino = 27;
-
+  foo();
   return 0; // break here
 }

github-actions · 2024-08-10T00:40:17Z

✅ With the latest revision this PR passed the Python code formatter.

github-actions · 2024-08-10T00:40:17Z

✅ With the latest revision this PR passed the C/C++ code formatter.

lldb/include/lldb/Target/Statistics.h

lldb/source/Target/Statistics.cpp

lldb/include/lldb/Target/Statistics.h

lldb/source/Core/ValueObject.cpp

lldb/include/lldb/Target/Statistics.h

lldb/test/API/commands/statistics/basic/TestStats.py

lldb/test/API/commands/statistics/basic/main.cpp

lldb/source/Core/ValueObject.cpp

Michael137 · 2024-08-12T15:48:49Z

Stats around this area could definitely be interesting to explore, thanks for looking into this!

lldb/source/Target/Target.cpp

lldb/include/lldb/Target/Statistics.h

lldb/include/lldb/Target/Target.h

lldb/include/lldb/Target/Statistics.h

lldb/source/Target/Statistics.cpp

lldb/test/API/commands/statistics/basic/TestStats.py

lldb/source/Core/ValueObject.cpp

lldb/test/API/commands/statistics/basic/main.cpp

clayborg · 2024-08-12T17:47:46Z

lldb/test/API/commands/statistics/basic/main.cpp

+#include <string>
+
+void foo() {
+  std::string str = "hello world";


We should also test a type that uses a template as some summary providers match based on a regex like:

std::vector<int> ints = {1, 2, 3}; std::vector<float> floats = {1.0, 2.0, 3.0};

From debugging we can see:

(lldb) type summary info ints summary applied to (std::vector<int>) ints is: (show children) (hide value) libc++ std::vector summary provider

And the summary definition looks like:

(lldb) type summary list ... ^std::vector<.+>(( )?&)?$: `size=${svar%#}` (show children) (hide value) ...

So the summary name we want to see in our resulting map is probably "^std::vector<.+>(( )?&)?$"

@clayborg

I created a basic template test, and made sure the formatter was invoked, and I added a different test for the two vector cases.

I did not test nested summaries, and will add it if desired.

lldb/include/lldb/Target/Statistics.h

clayborg · 2024-08-14T05:43:21Z

lldb/source/Core/ValueObject.cpp

@@ -602,7 +602,7 @@ bool ValueObject::GetSummaryAsCString(TypeSummaryImpl *summary_ptr,
    actual_options.SetLanguage(GetPreferredDisplayLanguage());

  // this is a hot path in code and we prefer to avoid setting this string all
-  // too often also clearing out other information that we might care to see in
+  // too often also clearing out other information that we might care` to see in


remove this extra character that was added

lldb/source/DataFormatters/TypeSummary.cpp

lldb/include/lldb/DataFormatters/TypeSummary.h

lldb/include/lldb/Target/Statistics.h

lldb/source/DataFormatters/TypeSummary.cpp

lldb/include/lldb/DataFormatters/TypeSummary.h

lldb/include/lldb/Target/Statistics.h

JDevlieghere · 2024-08-14T17:19:47Z

lldb/include/lldb/Target/Statistics.h

+  // Basic RAII class to increment the summary count when the call is complete.
+  // In the future this can be extended to collect information about the
+  // elapsed time for a single request.


Suggested change

// Basic RAII class to increment the summary count when the call is complete.

// In the future this can be extended to collect information about the

// elapsed time for a single request.

/// Basic RAII class to increment the summary count when the call is complete.

/// In the future this can be extended to collect information about the

/// elapsed time for a single request.

lldb/include/lldb/Target/Statistics.h

lldb/source/DataFormatters/TypeSummary.cpp

lldb/source/Core/ValueObject.cpp

lldb/include/lldb/Target/Statistics.h

…tats constructor

Michael137 · 2024-08-19T17:15:51Z

lldb/source/Core/ValueObject.cpp

+
+    TargetSP target_sp = GetExecutionContextRef().GetTargetSP();
+    if (target_sp) {
+      // Get Shared pointer to the summary statistics container


Suggested change

// Get Shared pointer to the summary statistics container

Nit: don't need the comment here

Michael137 · 2024-08-19T17:22:47Z

lldb/include/lldb/Target/Statistics.h

+  /// 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) {


Yea it's mostly personal preference, thanks for addressing all the comments so far. This approach seems fine to me too (though I've had enough time to let it sink in, not sure it'd be straightforward to reason about for someone new to this).

Michael137 · 2024-08-19T17:23:58Z

lldb/include/lldb/Target/Statistics.h

+  std::atomic<uint64_t> m_count;
+};
+
+typedef std::shared_ptr<SummaryStatistics> SummaryStatisticsSP;


Not sure what the exact policy is but i think we define all of these in lldb-forward.h (given you expose it in the header here anyway, probably best to move it there, but will defer to @clayborg )

Michael137 · 2024-08-19T17:33:06Z

lldb/test/API/commands/statistics/basic/main.cpp

@@ -0,0 +1,35 @@
+// Test that the lldb command `statistics` works.


Not aware of anything like this off-the-top. We'd want a test that access the same Target from multiple threads and formats types. Maybe having some callback tied to several threads within the target which trigger a ValueObject::GetSummaryAsCString call. @clayborg @jimingham might have some more concrete ideas on how to do that.

lldb/source/Core/ValueObject.cpp

lldb/include/lldb/Target/Statistics.h

… unit tests

Michael137

LGTM (left some minor comments)

lldb/source/DataFormatters/TypeSummary.cpp

lldb/unittests/Target/SummaryStatisticsTest.cpp

Jlalond · 2024-08-23T19:25:16Z

@Michael137 implemented your feedback, and I got gcf to work. I'm going to let CI run and then merge. Thanks for your patience!

…mes they're summary strings.

lldb/include/lldb/Target/Statistics.h

clayborg · 2024-08-16T07:21:25Z

lldb/include/lldb/Target/Statistics.h

+  /// 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) {


So with your suggestion the RAII object would need to copy the string so that it could call Update at the and to find the stats and then update the time. This also means the RAII object needs to hold a reference to the SummaryStatisticsCache global object, which could get destructed as nothing is keeping it alive. So we need to have the RAII object copy the string and get a weak pointer to the SummaryStatisticsCache so it can safely update the results in the end.

This current solution hands out a SummaryStatisticsSP to the RAII object which will keep it alive so it can get updated, and if the SummaryStatisticsCache goes away, it is ok because we have a strong reference. Both solutions only do 1 lookup. std::shared_ptr<T> objects are thread safe.

The StringMap requires a value that can be copied when the map grows and re-allocation happen, so if we don't use a shared pointer, then we need SummaryStatistics to have a move operator.

So I don't mind this solution, but would like to hear other opinions

clayborg · 2024-09-04T20:20:05Z

lldb/include/lldb/DataFormatters/TypeSummary.h

+
+  /// Get the name of the kind of Summary Provider, either c++, summary string,
+  /// script or python.
+  virtual std::string GetSummaryKindName() = 0;


Should this be a string or an enum? I would vote for an lldb_internal enum. That way plug-ins know what to choose form and don't make up random stuff.

I'm not opposed to the enum, but I think if we're using an enum we should leverage 'TypeSummaryKind`, the existing kind enum and we should to string that.

My question is how we handle script, currently I check if it's a .py and if it is we call it Python. Do we want to default to Python for all scripts?

@Michael137 I talked to Greg offline about this, but do we support any SWIG interfaced languages other than Python? I believe I've seen Lua in the wild. If that's the case I'd like to keep the differentiation, but for this first patch we could get away with just Python

lldb/source/DataFormatters/TypeSummary.cpp

llvm-ci · 2024-09-10T19:09:35Z

LLVM Buildbot has detected a new failure on builder lldb-aarch64-windows running on linaro-armv8-windows-msvc-05 while building lldb at step 6 "test".

Full details are available at: https://lab.llvm.org/buildbot/#/builders/141/builds/2290

Here is the relevant piece of the build log for the reference

Step 6 (test) failure: build (failure)
...
PASS: lldb-api :: commands/session/history/TestSessionHistory.py (211 of 2016)
PASS: lldb-api :: commands/session/save/TestSessionSave.py (212 of 2016)
PASS: lldb-api :: commands/settings/TestSettings.py (213 of 2016)
PASS: lldb-api :: commands/settings/quoting/TestQuoting.py (214 of 2016)
PASS: lldb-api :: commands/settings/use_source_cache/TestUseSourceCache.py (215 of 2016)
PASS: lldb-api :: commands/process/attach/TestProcessAttach.py (216 of 2016)
PASS: lldb-api :: commands/source/info/TestSourceInfo.py (217 of 2016)
UNSUPPORTED: lldb-api :: commands/target/auto-install-main-executable/TestAutoInstallMainExecutable.py (218 of 2016)
PASS: lldb-api :: commands/target/basic/TestTargetCommand.py (219 of 2016)
UNSUPPORTED: lldb-api :: commands/target/create-deps/TestTargetCreateDeps.py (220 of 2016)
FAIL: lldb-api :: commands/statistics/basic/TestStats.py (221 of 2016)
******************** TEST 'lldb-api :: commands/statistics/basic/TestStats.py' FAILED ********************
Script:
--
C:/Users/tcwg/scoop/apps/python/current/python.exe C:/Users/tcwg/llvm-worker/lldb-aarch64-windows/llvm-project/lldb\test\API\dotest.py -u CXXFLAGS -u CFLAGS --env OBJCOPY=C:/Users/tcwg/llvm-worker/lldb-aarch64-windows/build/./bin/llvm-objcopy.exe --env LLVM_LIBS_DIR=C:/Users/tcwg/llvm-worker/lldb-aarch64-windows/build/./lib --env LLVM_INCLUDE_DIR=C:/Users/tcwg/llvm-worker/lldb-aarch64-windows/build/include --env LLVM_TOOLS_DIR=C:/Users/tcwg/llvm-worker/lldb-aarch64-windows/build/./bin --arch aarch64 --build-dir C:/Users/tcwg/llvm-worker/lldb-aarch64-windows/build/lldb-test-build.noindex --lldb-module-cache-dir C:/Users/tcwg/llvm-worker/lldb-aarch64-windows/build/lldb-test-build.noindex/module-cache-lldb\lldb-api --clang-module-cache-dir C:/Users/tcwg/llvm-worker/lldb-aarch64-windows/build/lldb-test-build.noindex/module-cache-clang\lldb-api --executable C:/Users/tcwg/llvm-worker/lldb-aarch64-windows/build/./bin/lldb.exe --compiler C:/Users/tcwg/llvm-worker/lldb-aarch64-windows/build/./bin/clang.exe --dsymutil C:/Users/tcwg/llvm-worker/lldb-aarch64-windows/build/./bin/dsymutil.exe --llvm-tools-dir C:/Users/tcwg/llvm-worker/lldb-aarch64-windows/build/./bin --lldb-obj-root C:/Users/tcwg/llvm-worker/lldb-aarch64-windows/build/tools/lldb --lldb-libs-dir C:/Users/tcwg/llvm-worker/lldb-aarch64-windows/build/./lib --skip-category=watchpoint C:\Users\tcwg\llvm-worker\lldb-aarch64-windows\llvm-project\lldb\test\API\commands\statistics\basic -p TestStats.py
--
Exit Code: 1

Command Output (stdout):
--
lldb version 20.0.0git (https://github.com/llvm/llvm-project.git revision 22144e20cbd237a432fdc4106abe3960555aff42)
  clang revision 22144e20cbd237a432fdc4106abe3960555aff42
  llvm revision 22144e20cbd237a432fdc4106abe3960555aff42
Skipping the following test categories: ['watchpoint', 'libc++', 'libstdcxx', 'dwo', 'dsym', 'gmodules', 'debugserver', 'objc', 'fork', 'pexpect']


--
Command Output (stderr):
--
PASS: LLDB (C:\Users\tcwg\llvm-worker\lldb-aarch64-windows\build\bin\clang.exe-aarch64) :: test_breakpoints (TestStats.TestCase.test_breakpoints)

PASS: LLDB (C:\Users\tcwg\llvm-worker\lldb-aarch64-windows\build\bin\clang.exe-aarch64) :: test_commands (TestStats.TestCase.test_commands)

PASS: LLDB (C:\Users\tcwg\llvm-worker\lldb-aarch64-windows\build\bin\clang.exe-aarch64) :: test_default_no_run (TestStats.TestCase.test_default_no_run)

PASS: LLDB (C:\Users\tcwg\llvm-worker\lldb-aarch64-windows\build\bin\clang.exe-aarch64) :: test_default_with_run (TestStats.TestCase.test_default_with_run)

UNSUPPORTED: LLDB (C:\Users\tcwg\llvm-worker\lldb-aarch64-windows\build\bin\clang.exe-aarch64) :: test_dsym_binary_has_symfile_in_stats (TestStats.TestCase.test_dsym_binary_has_symfile_in_stats) (requires one of macosx, darwin, ios, tvos, watchos, bridgeos, iphonesimulator, watchsimulator, appletvsimulator) 

PASS: LLDB (C:\Users\tcwg\llvm-worker\lldb-aarch64-windows\build\bin\clang.exe-aarch64) :: test_enable_disable (TestStats.TestCase.test_enable_disable)

PASS: LLDB (C:\Users\tcwg\llvm-worker\lldb-aarch64-windows\build\bin\clang.exe-aarch64) :: test_expressions_frame_var_counts (TestStats.TestCase.test_expressions_frame_var_counts)

UNSUPPORTED: LLDB (C:\Users\tcwg\llvm-worker\lldb-aarch64-windows\build\bin\clang.exe-aarch64) :: test_had_frame_variable_errors (TestStats.TestCase.test_had_frame_variable_errors) (requires one of macosx, darwin, ios, tvos, watchos, bridgeos, iphonesimulator, watchsimulator, appletvsimulator) 

PASS: LLDB (C:\Users\tcwg\llvm-worker\lldb-aarch64-windows\build\bin\clang.exe-aarch64) :: test_memory (TestStats.TestCase.test_memory)

PASS: LLDB (C:\Users\tcwg\llvm-worker\lldb-aarch64-windows\build\bin\clang.exe-aarch64) :: test_modules (TestStats.TestCase.test_modules)

Jlalond · 2024-09-10T20:03:09Z

Investigating the windows issue

Follow up to #102708, the tests are failing for windows. There is a large variance in these tests between summary strings and built in types. I'm disabling these test for windows, and will add windows specific tests as a follow up to this.

…providers within lldb (llvm#102708) This PR adds a statistics provider cache, which allows an individual target to keep a rolling tally of it's total time and number of invocations for a given summary provider. This information is then available in statistics dump to help slow summary providers, and gleam more into insight into LLDB's time use. (cherry picked from commit 22144e2)

Jlalond requested a review from JDevlieghere as a code owner August 10, 2024 00:36

Jlalond requested review from clayborg and royitaqi and removed request for JDevlieghere August 10, 2024 00:36

llvmbot added the lldb label Aug 10, 2024

Jlalond requested a review from mbucko August 10, 2024 00:36

mbucko requested changes Aug 12, 2024

View reviewed changes

Michael137 reviewed Aug 12, 2024

View reviewed changes

lldb/test/API/commands/statistics/basic/TestStats.py Outdated Show resolved Hide resolved

Michael137 reviewed Aug 12, 2024

View reviewed changes

lldb/test/API/commands/statistics/basic/main.cpp Show resolved Hide resolved

Michael137 reviewed Aug 12, 2024

View reviewed changes

lldb/source/Core/ValueObject.cpp Outdated Show resolved Hide resolved

Michael137 requested a review from kastiglione August 12, 2024 15:47

bulbazord reviewed Aug 12, 2024

View reviewed changes

clayborg requested changes Aug 12, 2024

View reviewed changes

Jlalond requested a review from jeffreytan81 August 13, 2024 17:50

clayborg requested changes Aug 14, 2024

View reviewed changes

Michael137 reviewed Aug 14, 2024

View reviewed changes

lldb/include/lldb/Target/Statistics.h Outdated Show resolved Hide resolved

Michael137 reviewed Aug 14, 2024

View reviewed changes

lldb/source/DataFormatters/TypeSummary.cpp Outdated Show resolved Hide resolved

Michael137 reviewed Aug 14, 2024

View reviewed changes

lldb/include/lldb/DataFormatters/TypeSummary.h Outdated Show resolved Hide resolved

Michael137 reviewed Aug 14, 2024

View reviewed changes

lldb/include/lldb/Target/Statistics.h Outdated Show resolved Hide resolved

Jlalond force-pushed the variable-summary-statistics branch 2 times, most recently from 5993716 to 7b4b7fc Compare August 14, 2024 17:04

JDevlieghere reviewed Aug 14, 2024

View reviewed changes

Michael137 reviewed Aug 14, 2024

View reviewed changes

lldb/source/Core/ValueObject.cpp Outdated Show resolved Hide resolved

Michael137 reviewed Aug 14, 2024

View reviewed changes

lldb/include/lldb/Target/Statistics.h Outdated Show resolved Hide resolved

Michael137 reviewed Aug 14, 2024

View reviewed changes

lldb/include/lldb/Target/Statistics.h Outdated Show resolved Hide resolved

Jlalond added 2 commits August 19, 2024 10:02

Actually rename variables in test after changing json key names

a0172fd

Rebase and implement Michael's feedback on std::move in the summary s…

4a2f234

…tats constructor

Jlalond force-pushed the variable-summary-statistics branch from 2a9443c to 4a2f234 Compare August 19, 2024 17:04

Michael137 reviewed Aug 19, 2024

View reviewed changes

Jlalond added 5 commits August 19, 2024 11:34

Reformat code and add note

72c6f2f

Implement more feedback on naming, and finally add some multithreaded…

7c0894d

… unit tests

Format

4ffeef9

Remove comment

dcaeda6

Add comment why SummaryStatSp isn't forward declared

479e6b5

Michael137 approved these changes Aug 23, 2024

View reviewed changes

lldb/source/DataFormatters/TypeSummary.cpp Show resolved Hide resolved

lldb/source/DataFormatters/TypeSummary.cpp Outdated Show resolved Hide resolved

lldb/unittests/Target/SummaryStatisticsTest.cpp Outdated Show resolved Hide resolved

Final tidy up feedback and run clang-format

9f9134e

Rework tests a bit to support the CI introduced edgecase where someti…

aa71d5f

…mes they're summary strings.

clayborg reviewed Sep 4, 2024

View reviewed changes

Jlalond force-pushed the variable-summary-statistics branch from 3796858 to 76a3103 Compare September 5, 2024 20:16

Move to a unified function for the kind name

f63080b

Jlalond force-pushed the variable-summary-statistics branch from 76a3103 to f63080b Compare September 9, 2024 17:57

Jlalond added 2 commits September 9, 2024 11:29

Run py formatter

c847083

Make box summary more generic so it works on all CI hosts

3cccbba

clayborg approved these changes Sep 10, 2024

View reviewed changes

Jlalond merged commit 22144e2 into llvm:main Sep 10, 2024
7 checks passed

Jlalond mentioned this pull request Sep 10, 2024

[LLDB]Skip Summary Statistics Tests for Windows #108079

Merged

Jlalond deleted the variable-summary-statistics branch March 7, 2025 19:20

		@@ -0,0 +1,35 @@
		// Test that the lldb command `statistics` works.

[LLDB][Data Formatters] Calculate average and total time for summary providers within lldb #102708

[LLDB][Data Formatters] Calculate average and total time for summary providers within lldb #102708

Uh oh!

Conversation

Jlalond commented Aug 10, 2024

Uh oh!

llvmbot commented Aug 10, 2024

Uh oh!

github-actions bot commented Aug 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Aug 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Michael137 commented Aug 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Michael137 Aug 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

github-actions bot commented Aug 10, 2024 •

edited

Loading

github-actions bot commented Aug 10, 2024 •

edited

Loading

Michael137 commented Aug 12, 2024 •

edited

Loading

Michael137 Aug 19, 2024 •

edited

Loading