1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
//===-- Progress.cpp ------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "lldb/Core/Progress.h"
#include "lldb/Core/Debugger.h"
#include "lldb/Utility/StreamString.h"
#include "llvm/Support/Signposts.h"
#include <atomic>
#include <chrono>
#include <cstdint>
#include <mutex>
#include <optional>
using namespace lldb;
using namespace lldb_private;
std::atomic<uint64_t> Progress::g_id(0);
// Instrument progress events with signposts when supported.
static llvm::ManagedStatic<llvm::SignpostEmitter> g_progress_signposts;
Progress::Progress(std::string title, std::string details,
std::optional<uint64_t> total,
lldb_private::Debugger *debugger,
Timeout<std::nano> minimum_report_time,
Progress::Origin origin)
: m_total(total.value_or(Progress::kNonDeterministicTotal)),
m_minimum_report_time(minimum_report_time), m_title(title),
m_progress_id(++g_id),
m_debugger_id(debugger ? std::optional<user_id_t>(debugger->GetID())
: std::nullopt),
m_origin(origin),
m_last_report_time_ns(
std::chrono::nanoseconds(
std::chrono::steady_clock::now().time_since_epoch())
.count()),
m_details(std::move(details)) {
std::lock_guard<std::mutex> guard(m_mutex);
ReportProgress();
// Start signpost interval right before the meaningful work starts.
g_progress_signposts->startInterval(this, m_title);
}
Progress::~Progress() {
// End signpost interval as soon as possible.
g_progress_signposts->endInterval(this, m_title);
// Make sure to always report progress completed when this object is
// destructed so it indicates the progress dialog/activity should go away.
std::lock_guard<std::mutex> guard(m_mutex);
m_completed = m_total;
ReportProgress();
}
void Progress::Increment(uint64_t amount,
std::optional<std::string> updated_detail) {
if (amount == 0)
return;
m_completed.fetch_add(amount, std::memory_order_relaxed);
if (m_minimum_report_time) {
using namespace std::chrono;
nanoseconds now;
uint64_t last_report_time_ns =
m_last_report_time_ns.load(std::memory_order_relaxed);
do {
now = steady_clock::now().time_since_epoch();
if (now < nanoseconds(last_report_time_ns) + *m_minimum_report_time)
return; // Too little time has passed since the last report.
} while (!m_last_report_time_ns.compare_exchange_weak(
last_report_time_ns, now.count(), std::memory_order_relaxed,
std::memory_order_relaxed));
}
std::lock_guard<std::mutex> guard(m_mutex);
if (updated_detail)
m_details = std::move(updated_detail.value());
ReportProgress();
}
void Progress::ReportProgress() {
// NB: Comparisons with optional<T> rely on the fact that std::nullopt is
// "smaller" than zero.
if (m_prev_completed >= m_total)
return; // We've reported completion already.
uint64_t completed =
std::min(m_completed.load(std::memory_order_relaxed), m_total);
if (completed < m_prev_completed)
return; // An overflow in the m_completed counter. Just ignore these events.
// Change the category bit if we're an internal or external progress.
uint32_t progress_category_bit = m_origin == Progress::Origin::eExternal
? lldb::eBroadcastBitExternalProgress
: lldb::eBroadcastBitProgress;
Debugger::ReportProgress(m_progress_id, m_title, m_details, completed,
m_total, m_debugger_id, progress_category_bit);
m_prev_completed = completed;
}
|
