Skip to content

Commit 17bd069

Browse files
kusmourkusmour
committed
Create SBStatisticsOptions API
Summary: We can't take away or change a previously available public API function. To avoid future changes, intruduce an option class that we can extend without modifying existing APIs.
1 parent 94aa92d commit 17bd069

File tree

17 files changed

+156
-26
lines changed

17 files changed

+156
-26
lines changed

‎lldb/bindings/headers.swig

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@
5454
#include "lldb/API/SBScriptObject.h"
5555
#include "lldb/API/SBSection.h"
5656
#include "lldb/API/SBSourceManager.h"
57+
#include "lldb/API/SBStatisticsOptions.h"
5758
#include "lldb/API/SBStream.h"
5859
#include "lldb/API/SBStringList.h"
5960
#include "lldb/API/SBStructuredData.h"

‎lldb/bindings/interface/SBStatisticsOptionsDocStrings.i

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
%feature("docstring",
2+
"A container for options to use when dumping statistics."
3+
) lldb::SBStatisticsOptions;
4+
5+
%feature("docstring", "Sets whether the statistics should only dump a summary."
6+
) lldb::SBStatisticsOptions::SetSummaryOnly;
7+
%feature("docstring", "Gets whether the statistics only dump a summary."
8+
) lldb::SBStatisticsOptions::GetSummaryOnly;

‎lldb/bindings/interfaces.swig

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@
5656
%include "./interface/SBReproducerDocstrings.i"
5757
%include "./interface/SBSectionDocstrings.i"
5858
%include "./interface/SBSourceManagerDocstrings.i"
59+
%include "./interface/SBStatisticsOptionsDocstrings.i"
5960
%include "./interface/SBStreamDocstrings.i"
6061
%include "./interface/SBStringListDocstrings.i"
6162
%include "./interface/SBStructuredDataDocstrings.i"
@@ -131,6 +132,7 @@
131132
%include "lldb/API/SBScriptObject.h"
132133
%include "lldb/API/SBSection.h"
133134
%include "lldb/API/SBSourceManager.h"
135+
%include "lldb/API/SBStatisticsOptions.h"
134136
%include "lldb/API/SBStream.h"
135137
%include "lldb/API/SBStringList.h"
136138
%include "lldb/API/SBStructuredData.h"

‎lldb/include/lldb/API/LLDB.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@
5656
#include "lldb/API/SBReproducer.h"
5757
#include "lldb/API/SBSection.h"
5858
#include "lldb/API/SBSourceManager.h"
59+
#include "lldb/API/SBStatisticsOptions.h"
5960
#include "lldb/API/SBStream.h"
6061
#include "lldb/API/SBStringList.h"
6162
#include "lldb/API/SBStructuredData.h"

‎lldb/include/lldb/API/SBDefines.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ class LLDB_API SBReproducer;
9999
class LLDB_API SBScriptObject;
100100
class LLDB_API SBSection;
101101
class LLDB_API SBSourceManager;
102+
class LLDB_API SBStatisticsOptions;
102103
class LLDB_API SBStream;
103104
class LLDB_API SBStringList;
104105
class LLDB_API SBStructuredData;

‎lldb/include/lldb/API/SBStatisticsOptions.h

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
//===-- SBStatisticsOptions.h -----------------------------------*- 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+
#ifndef LLDB_API_SBSTATISTICSOPTIONS_H
10+
#define LLDB_API_SBSTATISTICSOPTIONS_H
11+
12+
#include "lldb/API/SBDefines.h"
13+
14+
namespace lldb {
15+
16+
/// This class handles the verbosity when dumping statistics
17+
class LLDB_API SBStatisticsOptions {
18+
public:
19+
SBStatisticsOptions();
20+
SBStatisticsOptions(const lldb::SBStatisticsOptions &rhs);
21+
~SBStatisticsOptions();
22+
23+
const SBStatisticsOptions &operator=(const lldb::SBStatisticsOptions &rhs);
24+
25+
void SetSummaryOnly(bool b);
26+
bool GetSummaryOnly();
27+
28+
protected:
29+
friend class SBTarget;
30+
const lldb_private::StatisticsOptions &ref() const;
31+
32+
private:
33+
std::unique_ptr<lldb_private::StatisticsOptions> m_opaque_up;
34+
};
35+
} // namespace lldb
36+
#endif // LLDB_API_SBSTATISTICSOPTIONS_H

‎lldb/include/lldb/API/SBTarget.h

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
#include "lldb/API/SBFileSpec.h"
1818
#include "lldb/API/SBFileSpecList.h"
1919
#include "lldb/API/SBLaunchInfo.h"
20+
#include "lldb/API/SBStatisticsOptions.h"
2021
#include "lldb/API/SBSymbolContextList.h"
2122
#include "lldb/API/SBType.h"
2223
#include "lldb/API/SBValue.h"
@@ -86,13 +87,18 @@ class LLDB_API SBTarget {
8687

8788
/// Returns a dump of the collected statistics.
8889
///
89-
/// \param[in] summary_only
90-
/// If true, only report high level summary statistics without
91-
/// targets/modules/breakpoints etc.. details.
90+
/// \return
91+
/// A SBStructuredData with the statistics collected.
92+
lldb::SBStructuredData GetStatistics();
93+
94+
/// Returns a dump of the collected statistics.
95+
///
96+
/// \param[in] options
97+
/// An objects object that contains all options for the statistics dumping.
9298
///
9399
/// \return
94100
/// A SBStructuredData with the statistics collected.
95-
lldb::SBStructuredData GetStatistics(bool summary_only = false);
101+
lldb::SBStructuredData GetStatistics(SBStatisticsOptions options);
96102

97103
/// Return the platform object associated with the target.
98104
///

‎lldb/include/lldb/Target/Statistics.h

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -130,10 +130,15 @@ struct ConstStringStats {
130130
ConstString::MemoryStats stats = ConstString::GetMemoryStats();
131131
};
132132

133+
struct StatisticsOptions {
134+
bool summary_only = false;
135+
};
136+
133137
/// A class that represents statistics for a since lldb_private::Target.
134138
class TargetStats {
135139
public:
136-
llvm::json::Value ToJSON(Target &target, bool summary_only = false);
140+
llvm::json::Value ToJSON(Target &target,
141+
const lldb_private::StatisticsOptions &options);
137142

138143
void SetLaunchOrAttachTime();
139144
void SetFirstPrivateStopTime();
@@ -177,8 +182,9 @@ class DebuggerStats {
177182
///
178183
/// \return
179184
/// Returns a JSON value that contains all target metrics.
180-
static llvm::json::Value ReportStatistics(Debugger &debugger, Target *target,
181-
bool summary_only = false);
185+
static llvm::json::Value
186+
ReportStatistics(Debugger &debugger, Target *target,
187+
const lldb_private::StatisticsOptions &options);
182188

183189
protected:
184190
// Collecting stats can be set to true to collect stats that are expensive

‎lldb/include/lldb/Target/Target.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1599,7 +1599,8 @@ class Target : public std::enable_shared_from_this<Target>,
15991599
///
16001600
/// \return
16011601
/// Returns a JSON value that contains all target metrics.
1602-
llvm::json::Value ReportStatistics(bool summary_only = false);
1602+
llvm::json::Value
1603+
ReportStatistics(const lldb_private::StatisticsOptions &options);
16031604

16041605
TargetStats &GetStatistics() { return m_stats; }
16051606

‎lldb/include/lldb/lldb-forward.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,7 @@ struct CompilerContext;
298298
struct LineEntry;
299299
struct PropertyDefinition;
300300
struct ScriptSummaryFormat;
301+
struct StatisticsOptions;
301302
struct StringSummaryFormat;
302303
template <unsigned N> class StreamBuffer;
303304

‎lldb/source/API/CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ add_lldb_library(liblldb SHARED ${option_framework}
6969
SBScriptObject.cpp
7070
SBSection.cpp
7171
SBSourceManager.cpp
72+
SBStatisticsOptions.cpp
7273
SBStream.cpp
7374
SBStringList.cpp
7475
SBStructuredData.cpp

‎lldb/source/API/SBStatisticsOptions.cpp

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
//===-- SBStatisticsOptions.cpp -------------------------------------------===//
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 "lldb/API/SBStatisticsOptions.h"
10+
#include "lldb/Target/Statistics.h"
11+
#include "lldb/Utility/Instrumentation.h"
12+
13+
#include "Utils.h"
14+
15+
using namespace lldb;
16+
using namespace lldb_private;
17+
18+
SBStatisticsOptions::SBStatisticsOptions()
19+
: m_opaque_up(new StatisticsOptions()) {
20+
LLDB_INSTRUMENT_VA(this);
21+
m_opaque_up->summary_only = false;
22+
}
23+
24+
SBStatisticsOptions::SBStatisticsOptions(const SBStatisticsOptions &rhs) {
25+
LLDB_INSTRUMENT_VA(this, rhs);
26+
27+
m_opaque_up = clone(rhs.m_opaque_up);
28+
}
29+
30+
SBStatisticsOptions::~SBStatisticsOptions() = default;
31+
32+
const SBStatisticsOptions &
33+
SBStatisticsOptions::operator=(const SBStatisticsOptions &rhs) {
34+
LLDB_INSTRUMENT_VA(this, rhs);
35+
36+
if (this != &rhs)
37+
m_opaque_up = clone(rhs.m_opaque_up);
38+
return *this;
39+
}
40+
41+
void SBStatisticsOptions::SetSummaryOnly(bool b) {
42+
m_opaque_up->summary_only = b;
43+
}
44+
45+
bool SBStatisticsOptions::GetSummaryOnly() { return m_opaque_up->summary_only; }
46+
47+
const lldb_private::StatisticsOptions &SBStatisticsOptions::ref() const {
48+
return *m_opaque_up;
49+
}

‎lldb/source/API/SBTarget.cpp

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -197,17 +197,23 @@ SBDebugger SBTarget::GetDebugger() const {
197197
return debugger;
198198
}
199199

200-
SBStructuredData SBTarget::GetStatistics(bool summary_only) {
200+
SBStructuredData SBTarget::GetStatistics() {
201+
LLDB_INSTRUMENT_VA(this);
202+
SBStatisticsOptions options;
203+
return GetStatistics(options);
204+
}
205+
206+
SBStructuredData SBTarget::GetStatistics(SBStatisticsOptions options) {
201207
LLDB_INSTRUMENT_VA(this);
202208

203209
SBStructuredData data;
204210
TargetSP target_sp(GetSP());
205211
if (!target_sp)
206212
return data;
207213
std::string json_str =
208-
llvm::formatv(
209-
"{0:2}", DebuggerStats::ReportStatistics(
210-
target_sp->GetDebugger(), target_sp.get(), summary_only))
214+
llvm::formatv("{0:2}", DebuggerStats::ReportStatistics(
215+
target_sp->GetDebugger(), target_sp.get(),
216+
options.ref()))
211217
.str();
212218
data.m_impl_up->SetObjectSP(StructuredData::ParseJSON(json_str));
213219
return data;

‎lldb/source/Commands/CommandObjectStats.cpp

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ class CommandObjectStatsDump : public CommandObjectParsed {
7676
m_all_targets = true;
7777
break;
7878
case 's':
79-
m_summary_only = true;
79+
m_stats_options.summary_only = true;
8080
break;
8181
default:
8282
llvm_unreachable("Unimplemented option");
@@ -86,15 +86,17 @@ class CommandObjectStatsDump : public CommandObjectParsed {
8686

8787
void OptionParsingStarting(ExecutionContext *execution_context) override {
8888
m_all_targets = false;
89-
m_summary_only = false;
89+
m_stats_options = StatisticsOptions();
9090
}
9191

9292
llvm::ArrayRef<OptionDefinition> GetDefinitions() override {
9393
return llvm::ArrayRef(g_statistics_dump_options);
9494
}
9595

96+
StatisticsOptions GetStatisticsOptions() { return m_stats_options; }
97+
9698
bool m_all_targets = false;
97-
bool m_summary_only = false;
99+
StatisticsOptions m_stats_options = StatisticsOptions();
98100
};
99101

100102
public:
@@ -114,8 +116,8 @@ class CommandObjectStatsDump : public CommandObjectParsed {
114116
target = m_exe_ctx.GetTargetPtr();
115117

116118
result.AppendMessageWithFormatv(
117-
"{0:2}", DebuggerStats::ReportStatistics(GetDebugger(), target,
118-
m_options.m_summary_only));
119+
"{0:2}", DebuggerStats::ReportStatistics(
120+
GetDebugger(), target, m_options.GetStatisticsOptions()));
119121
result.SetStatus(eReturnStatusSuccessFinishResult);
120122
}
121123

‎lldb/source/Target/Statistics.cpp

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,12 @@ llvm::json::Value ConstStringStats::ToJSON() const {
101101
return obj;
102102
}
103103

104-
json::Value TargetStats::ToJSON(Target &target, bool summary_only) {
104+
json::Value
105+
TargetStats::ToJSON(Target &target,
106+
const lldb_private::StatisticsOptions &options) {
105107
json::Object target_metrics_json;
106108
ProcessSP process_sp = target.GetProcessSP();
109+
bool summary_only = options.summary_only;
107110
if (!summary_only) {
108111
CollectStats(target);
109112

@@ -216,9 +219,12 @@ void TargetStats::IncreaseSourceMapDeduceCount() {
216219

217220
bool DebuggerStats::g_collecting_stats = false;
218221

219-
llvm::json::Value DebuggerStats::ReportStatistics(Debugger &debugger,
220-
Target *target,
221-
bool summary_only) {
222+
llvm::json::Value DebuggerStats::ReportStatistics(
223+
Debugger &debugger, Target *target,
224+
const lldb_private::StatisticsOptions &options) {
225+
226+
bool summary_only = options.summary_only;
227+
222228
json::Array json_targets;
223229
json::Array json_modules;
224230
double symtab_parse_time = 0.0;
@@ -338,10 +344,10 @@ llvm::json::Value DebuggerStats::ReportStatistics(Debugger &debugger,
338344
};
339345

340346
if (target) {
341-
json_targets.emplace_back(target->ReportStatistics(summary_only));
347+
json_targets.emplace_back(target->ReportStatistics(options));
342348
} else {
343349
for (const auto &target : debugger.GetTargetList().Targets())
344-
json_targets.emplace_back(target->ReportStatistics(summary_only));
350+
json_targets.emplace_back(target->ReportStatistics(options));
345351
}
346352
global_stats.try_emplace("targets", std::move(json_targets));
347353

‎lldb/source/Target/Target.cpp

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4962,6 +4962,7 @@ std::recursive_mutex &Target::GetAPIMutex() {
49624962
}
49634963

49644964
/// Get metrics associated with this target in JSON format.
4965-
llvm::json::Value Target::ReportStatistics(bool summary_only) {
4966-
return m_stats.ToJSON(*this, summary_only);
4965+
llvm::json::Value
4966+
Target::ReportStatistics(const lldb_private::StatisticsOptions &options) {
4967+
return m_stats.ToJSON(*this, options);
49674968
}

‎lldb/test/API/functionalities/stats_api/TestStatisticsAPI.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,9 @@ def test_stats_api(self):
7575
)
7676

7777
# Test statistics summary.
78-
stats_summary = target.GetStatistics(True)
78+
stats_options = lldb.SBStatisticsOptions()
79+
stats_options.SetSummaryOnly(True)
80+
stats_summary = target.GetStatistics(stats_options)
7981
stream_summary = lldb.SBStream()
8082
res = stats_summary.GetAsJSON(stream_summary)
8183
debug_stats_summary = json.loads(stream_summary.GetData())

0 commit comments

Comments
 (0)