JDevlieghere updated this revision to Diff 496577.
JDevlieghere marked 2 inline comments as done.
JDevlieghere added a comment.
- update -> details
- expose title and details separately in structured data
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D143690/new/
https://reviews.llvm.org/D143690
Files:
lldb/include/lldb/Core/Debugger.h
lldb/include/lldb/Core/DebuggerEvents.h
lldb/include/lldb/Core/Progress.h
lldb/source/API/SBDebugger.cpp
lldb/source/Core/Debugger.cpp
lldb/source/Core/DebuggerEvents.cpp
lldb/source/Core/Progress.cpp
Index: lldb/source/Core/Progress.cpp
===================================================================
--- lldb/source/Core/Progress.cpp
+++ lldb/source/Core/Progress.cpp
@@ -36,7 +36,7 @@
}
}
-void Progress::Increment(uint64_t amount) {
+void Progress::Increment(uint64_t amount, std::string update) {
if (amount > 0) {
std::lock_guard<std::mutex> guard(m_mutex);
// Watch out for unsigned overflow and make sure we don't increment too
@@ -45,16 +45,16 @@
m_completed = m_total;
else
m_completed += amount;
- ReportProgress();
+ ReportProgress(update);
}
}
-void Progress::ReportProgress() {
+void Progress::ReportProgress(std::string update) {
if (!m_complete) {
// Make sure we only send one notification that indicates the progress is
// complete.
m_complete = m_completed == m_total;
- Debugger::ReportProgress(m_id, m_title, m_completed, m_total,
- m_debugger_id);
+ Debugger::ReportProgress(m_id, m_title, std::move(update), m_completed,
+ m_total, m_debugger_id);
}
}
Index: lldb/source/Core/DebuggerEvents.cpp
===================================================================
--- lldb/source/Core/DebuggerEvents.cpp
+++ lldb/source/Core/DebuggerEvents.cpp
@@ -33,7 +33,9 @@
}
void ProgressEventData::Dump(Stream *s) const {
- s->Printf(" id = %" PRIu64 ", message = \"%s\"", m_id, m_message.c_str());
+ s->Printf(" id = %" PRIu64 ", title = \"%s\"", m_id, m_title.c_str());
+ if (!m_details.empty())
+ s->Printf(", details = \"%s\"", m_details.c_str());
if (m_completed == 0 || m_completed == m_total)
s->Printf(", type = %s", m_completed == 0 ? "start" : "end");
else
@@ -58,6 +60,8 @@
return {};
auto dictionary_sp = std::make_shared<StructuredData::Dictionary>();
+ dictionary_sp->AddStringItem("title", progress_data->GetTitle());
+ dictionary_sp->AddStringItem("details", progress_data->GetDetails());
dictionary_sp->AddStringItem("message", progress_data->GetMessage());
dictionary_sp->AddIntegerItem("progress_id", progress_data->GetID());
dictionary_sp->AddIntegerItem("completed", progress_data->GetCompleted());
Index: lldb/source/Core/Debugger.cpp
===================================================================
--- lldb/source/Core/Debugger.cpp
+++ lldb/source/Core/Debugger.cpp
@@ -1286,7 +1286,7 @@
}
static void PrivateReportProgress(Debugger &debugger, uint64_t progress_id,
- const std::string &message,
+ std::string title, std::string details,
uint64_t completed, uint64_t total,
bool is_debugger_specific) {
// Only deliver progress events if we have any progress listeners.
@@ -1294,13 +1294,15 @@
if (!debugger.GetBroadcaster().EventTypeHasListeners(event_type))
return;
EventSP event_sp(new Event(
- event_type, new ProgressEventData(progress_id, message, completed, total,
- is_debugger_specific)));
+ event_type,
+ new ProgressEventData(progress_id, std::move(title), std::move(details),
+ completed, total, is_debugger_specific)));
debugger.GetBroadcaster().BroadcastEvent(event_sp);
}
-void Debugger::ReportProgress(uint64_t progress_id, const std::string &message,
- uint64_t completed, uint64_t total,
+void Debugger::ReportProgress(uint64_t progress_id, std::string title,
+ std::string details, uint64_t completed,
+ uint64_t total,
std::optional<lldb::user_id_t> debugger_id) {
// Check if this progress is for a specific debugger.
if (debugger_id) {
@@ -1308,8 +1310,9 @@
// still exists.
DebuggerSP debugger_sp = FindDebuggerWithID(*debugger_id);
if (debugger_sp)
- PrivateReportProgress(*debugger_sp, progress_id, message, completed,
- total, /*is_debugger_specific*/ true);
+ PrivateReportProgress(*debugger_sp, progress_id, std::move(title),
+ std::move(details), completed, total,
+ /*is_debugger_specific*/ true);
return;
}
// The progress event is not debugger specific, iterate over all debuggers
@@ -1318,8 +1321,8 @@
std::lock_guard<std::recursive_mutex> guard(*g_debugger_list_mutex_ptr);
DebuggerList::iterator pos, end = g_debugger_list_ptr->end();
for (pos = g_debugger_list_ptr->begin(); pos != end; ++pos)
- PrivateReportProgress(*(*pos), progress_id, message, completed, total,
- /*is_debugger_specific*/ false);
+ PrivateReportProgress(*(*pos), progress_id, title, details, completed,
+ total, /*is_debugger_specific*/ false);
}
}
Index: lldb/source/API/SBDebugger.cpp
===================================================================
--- lldb/source/API/SBDebugger.cpp
+++ lldb/source/API/SBDebugger.cpp
@@ -157,6 +157,7 @@
uint64_t &total,
bool &is_debugger_specific) {
LLDB_INSTRUMENT_VA(event);
+
const ProgressEventData *progress_data =
ProgressEventData::GetEventDataFromEvent(event.get());
if (progress_data == nullptr)
@@ -165,7 +166,8 @@
completed = progress_data->GetCompleted();
total = progress_data->GetTotal();
is_debugger_specific = progress_data->IsDebuggerSpecific();
- return progress_data->GetMessage().c_str();
+ ConstString message(progress_data->GetMessage());
+ return message.AsCString();
}
lldb::SBStructuredData
Index: lldb/include/lldb/Core/Progress.h
===================================================================
--- lldb/include/lldb/Core/Progress.h
+++ lldb/include/lldb/Core/Progress.h
@@ -87,10 +87,12 @@
/// anything nor send any progress updates.
///
/// @param [in] amount The amount to increment m_completed by.
- void Increment(uint64_t amount = 1);
+ ///
+ /// @param [in] an optional message associated with this update.
+ void Increment(uint64_t amount = 1, std::string update = {});
private:
- void ReportProgress();
+ void ReportProgress(std::string update = {});
static std::atomic<uint64_t> g_id;
/// The title of the progress activity.
std::string m_title;
Index: lldb/include/lldb/Core/DebuggerEvents.h
===================================================================
--- lldb/include/lldb/Core/DebuggerEvents.h
+++ lldb/include/lldb/Core/DebuggerEvents.h
@@ -21,10 +21,11 @@
class ProgressEventData : public EventData {
public:
- ProgressEventData(uint64_t progress_id, const std::string &message,
+ ProgressEventData(uint64_t progress_id, std::string title, std::string update,
uint64_t completed, uint64_t total, bool debugger_specific)
- : m_message(message), m_id(progress_id), m_completed(completed),
- m_total(total), m_debugger_specific(debugger_specific) {}
+ : m_title(std::move(title)), m_details(std::move(update)),
+ m_id(progress_id), m_completed(completed), m_total(total),
+ m_debugger_specific(debugger_specific) {}
static ConstString GetFlavorString();
@@ -41,12 +42,30 @@
bool IsFinite() const { return m_total != UINT64_MAX; }
uint64_t GetCompleted() const { return m_completed; }
uint64_t GetTotal() const { return m_total; }
- const std::string &GetMessage() const { return m_message; }
+ std::string GetMessage() const {
+ std::string message = m_title;
+ if (!m_details.empty()) {
+ message.append(": ");
+ message.append(m_details);
+ }
+ return message;
+ }
+ const std::string &GetTitle() const { return m_title; }
+ const std::string &GetDetails() const { return m_details; }
bool IsDebuggerSpecific() const { return m_debugger_specific; }
private:
- std::string m_message;
+ /// The title of this progress event. The value is expected to remain stable
+ /// for a given progress ID.
+ std::string m_title;
+
+ /// Details associated with this progress event update. The value is expected
+ /// to change between progress events.
+ std::string m_details;
+
+ /// Unique ID used to associate progress events.
const uint64_t m_id;
+
uint64_t m_completed;
const uint64_t m_total;
const bool m_debugger_specific;
Index: lldb/include/lldb/Core/Debugger.h
===================================================================
--- lldb/include/lldb/Core/Debugger.h
+++ lldb/include/lldb/Core/Debugger.h
@@ -484,8 +484,9 @@
/// debugger identifier that this progress should be delivered to. If this
/// optional parameter does not have a value, the progress will be
/// delivered to all debuggers.
- static void ReportProgress(uint64_t progress_id, const std::string &message,
- uint64_t completed, uint64_t total,
+ static void ReportProgress(uint64_t progress_id, std::string title,
+ std::string details, uint64_t completed,
+ uint64_t total,
std::optional<lldb::user_id_t> debugger_id);
static void ReportDiagnosticImpl(DiagnosticEventData::Type type,
_______________________________________________
lldb-commits mailing list
lldb-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
