-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path0008-progress-Reporter-Add-interactive-reporting.patch
399 lines (380 loc) · 16 KB
/
0008-progress-Reporter-Add-interactive-reporting.patch
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
From: Oliver Reiche <[email protected]>
Date: Sun, 24 Dec 2023 11:29:36 +0100
Subject: [progress] Reporter: Add interactive reporting
---
bin/bootstrap.py | 2 +-
src/buildtool/common/cli.hpp | 22 +++-
src/buildtool/common/clidefaults.hpp | 3 +
src/buildtool/main/main.cpp | 5 +-
src/buildtool/progress_reporting/TARGETS | 1 +
.../base_progress_reporter.cpp | 13 +-
.../base_progress_reporter.hpp | 6 +-
.../progress_reporting/progress_reporter.cpp | 123 +++++++++++++++++-
.../progress_reporting/progress_reporter.hpp | 5 +-
src/other_tools/just_mr/cli.hpp | 24 +++-
src/other_tools/just_mr/launch.cpp | 14 ++
11 files changed, 200 insertions(+), 18 deletions(-)
diff --git a/bin/bootstrap.py b/bin/bootstrap.py
--- a/bin/bootstrap.py
+++ b/bin/bootstrap.py
@@ -467,7 +467,7 @@ def bootstrap() -> None:
run([
"./out-boot/%s" %
(MAIN_STAGE, ), "--norc", "--local-build-root", LOCAL_ROOT, "install",
- "-D", CONF_STRING, "-o", OUT, MAIN_MODULE, MAIN_TARGET
+ "-D", CONF_STRING, "--plain-log", "-o", OUT, MAIN_MODULE, MAIN_TARGET
],
cwd=src_wrkdir)
diff --git a/src/buildtool/common/cli.hpp b/src/buildtool/common/cli.hpp
--- a/src/buildtool/common/cli.hpp
+++ b/src/buildtool/common/cli.hpp
@@ -55,6 +55,8 @@ struct LogArguments {
std::optional<LogLevel> restrict_stderr_log_limit;
bool plain_log{false};
bool log_append{false};
+ std::size_t prog_interval{kDefaultProgInterval};
+ float prog_backoff_factor{kDefaultProgBackoffFactor};
};
/// \brief Arguments required for analysing targets.
@@ -263,13 +265,27 @@ static inline auto SetupLogArguments(
"Restrict logging on console to the minimum of the specified "
"--log-limit and this value")
->type_name("NUM");
- app->add_flag("--plain-log",
- clargs->plain_log,
- "Do not use ANSI escape sequences to highlight messages.");
+ app->add_flag_function(
+ "--plain-log",
+ [clargs](auto /*unused*/) {
+ clargs->plain_log = true;
+ clargs->prog_interval = kDefaultProgIntervalPlain;
+ },
+ "Disable color and interactive progress.");
app->add_flag(
"--log-append",
clargs->log_append,
"Append messages to log file instead of overwriting existing.");
+ app->add_option(
+ "--prog-interval",
+ clargs->prog_interval,
+ fmt::format("Progress interval in milliseconds (Default {}).",
+ kDefaultProgInterval));
+ app->add_option(
+ "--prog-backoff-factor",
+ clargs->prog_backoff_factor,
+ fmt::format("Progress interval backoff factor (Default {}).",
+ kDefaultProgBackoffFactor));
}
static inline auto SetupAnalysisArguments(
diff --git a/src/buildtool/common/clidefaults.hpp b/src/buildtool/common/clidefaults.hpp
--- a/src/buildtool/common/clidefaults.hpp
+++ b/src/buildtool/common/clidefaults.hpp
@@ -21,6 +21,9 @@
#include "src/buildtool/logging/log_level.hpp"
constexpr auto kDefaultLogLevel = LogLevel::Progress;
+constexpr auto kDefaultProgInterval = std::size_t{100};
+constexpr auto kDefaultProgIntervalPlain = std::size_t{3000};
+constexpr auto kDefaultProgBackoffFactor = 1.0F;
static inline const std::vector<std::string> kDefaultLauncher =
std::vector<std::string>{"env", "--"};
diff --git a/src/buildtool/main/main.cpp b/src/buildtool/main/main.cpp
--- a/src/buildtool/main/main.cpp
+++ b/src/buildtool/main/main.cpp
@@ -1006,7 +1006,10 @@ auto main(int argc, char* argv[]) -> int {
std::move(stage_args),
std::move(rebuild_args)},
&exec_context,
- ProgressReporter::Reporter(&stats, &progress)};
+ ProgressReporter::Reporter(&stats, &progress,
+ /*logger=*/nullptr,
+ /*fancy=*/true,
+ arguments.log)};
if (arguments.cmd == SubCommand::kInstallCas) {
if (not repo_config.SetGitCAS(storage_config->GitRoot())) {
diff --git a/src/buildtool/progress_reporting/TARGETS b/src/buildtool/progress_reporting/TARGETS
--- a/src/buildtool/progress_reporting/TARGETS
+++ b/src/buildtool/progress_reporting/TARGETS
@@ -28,6 +28,7 @@
[ "base_progress_reporter"
, "progress"
, ["@", "gsl", "", "gsl"]
+ , ["src/buildtool/common", "cli"]
, ["src/buildtool/common", "common"]
, ["src/buildtool/logging", "logging"]
]
diff --git a/src/buildtool/progress_reporting/base_progress_reporter.cpp b/src/buildtool/progress_reporting/base_progress_reporter.cpp
--- a/src/buildtool/progress_reporting/base_progress_reporter.cpp
+++ b/src/buildtool/progress_reporting/base_progress_reporter.cpp
@@ -35,22 +35,23 @@ void CallReport(std::function<void(void)> const& report) noexcept {
}
} // namespace
-auto BaseProgressReporter::Reporter(std::function<void(void)> report) noexcept
+auto BaseProgressReporter::Reporter(std::function<void(void)> report,
+ std::int64_t start_delay,
+ float backoff_factor) noexcept
-> progress_reporter_t {
- return [report = std::move(report)](std::atomic<bool>* done,
- std::condition_variable* cv) {
+ return [start_delay, backoff_factor, report = std::move(report)](
+ std::atomic<bool>* done, std::condition_variable* cv) {
std::mutex m;
std::unique_lock<std::mutex> lock(m);
- std::int64_t delay = kStartDelayMillis;
bool called{};
+ auto delay = start_delay;
while (not *done) {
cv->wait_for(lock, std::chrono::milliseconds(delay));
if (not *done) {
CallReport(report);
called = true;
}
- delay = delay * kDelayScalingFactorNumerator /
- kDelayScalingFactorDenominator;
+ delay = delay * backoff_factor;
}
if (called) {
// call a final time to print the latest state
diff --git a/src/buildtool/progress_reporting/base_progress_reporter.hpp b/src/buildtool/progress_reporting/base_progress_reporter.hpp
--- a/src/buildtool/progress_reporting/base_progress_reporter.hpp
+++ b/src/buildtool/progress_reporting/base_progress_reporter.hpp
@@ -29,7 +29,11 @@ using progress_reporter_t =
class BaseProgressReporter {
public:
[[nodiscard]] static auto Reporter(
- std::function<void(void)> report) noexcept -> progress_reporter_t;
+ std::function<void(void)> report,
+ std::int64_t start_delay = kStartDelayMillis,
+ float backoff_factor =
+ static_cast<float>(kDelayScalingFactorNumerator) /
+ kDelayScalingFactorDenominator) noexcept -> progress_reporter_t;
private:
constexpr static std::int64_t kStartDelayMillis = 3000;
diff --git a/src/buildtool/progress_reporting/progress_reporter.cpp b/src/buildtool/progress_reporting/progress_reporter.cpp
--- a/src/buildtool/progress_reporting/progress_reporter.cpp
+++ b/src/buildtool/progress_reporting/progress_reporter.cpp
@@ -16,13 +16,134 @@
#include <string>
+#include "fmt/color.h"
#include "fmt/core.h"
#include "src/buildtool/logging/log_level.hpp"
+namespace {
+
+class FancyReporter {
+ private:
+ constexpr static int kFancyMaxTasks = 8;
+ constexpr static int kFancyMaxCount = 10;
+ static inline const fmt::text_style kFancyColor =
+ fg(fmt::color::lime_green);
+
+ struct State {
+ int cached;
+ int run;
+ int queued;
+ std::vector<std::string> samples;
+ auto operator==(State const& other) const -> bool {
+ return cached == other.cached and run == other.run and
+ queued == other.queued and samples == other.samples;
+ }
+ };
+
+ public:
+ explicit FancyReporter(gsl::not_null<Statistics*> const& stats,
+ gsl::not_null<Progress*> const& progress,
+ Logger const* logger,
+ bool plain_log)
+ : stats_{stats},
+ progress_{progress},
+ logger_{logger},
+ plain_log_{plain_log} {}
+
+ [[nodiscard]] auto GetOriginString(std::string const& sample)
+ -> std::string {
+ auto const& origin_map = progress_->OriginMap();
+ auto origins = origin_map.find(sample);
+ if (origins != origin_map.end() and !origins->second.empty()) {
+ auto const& origin = origins->second[0];
+ return fmt::format(
+ "{}#{}", origin.first.target.ToString(), origin.second);
+ }
+ return sample;
+ }
+
+ [[nodiscard]] auto Colorize(std::string msg) -> std::string {
+ if (plain_log_) {
+ return msg;
+ }
+ return fmt::format(kFancyColor, "{}", msg);
+ }
+
+ void operator()() {
+ int total = gsl::narrow<int>(progress_->OriginMap().size());
+ int digits = (total > 0 ? static_cast<int>(log10(total)) : 0) + 1;
+
+ // Note: order matters; queued has to be queried last
+ State state = {stats_->ActionsCachedCounter(),
+ stats_->ActionsExecutedCounter(),
+ stats_->ActionsQueuedCounter(),
+ progress_->TaskTracker().Sample(kFancyMaxTasks)};
+
+ if (not plain_log_ and state_ == state and count_++ < kFancyMaxCount) {
+ // only update on change, but honor max count to force redraw
+ return;
+ }
+ count_ = 0;
+ state_ = state;
+
+ int active = state_.queued - state_.run - state_.cached;
+ auto const counter = Colorize(fmt::format(
+ "[{:{}}/{}]", state_.run + state_.cached, digits, total));
+
+ if (plain_log_) {
+ if (active > 0 and !state_.samples.empty()) {
+ Logger::Log(logger_,
+ LogLevel::Progress,
+ "{} {} cached, {} processing ({})",
+ counter,
+ state_.cached,
+ active,
+ GetOriginString(state_.samples.front()));
+ }
+ return;
+ }
+
+ std::string now_msg{};
+ if (active > 0 and !state_.samples.empty()) {
+ auto size = state_.samples.size();
+ for (int i{0}; i < size; ++i) {
+ auto const& sample = state_.samples[size - 1 - i];
+ now_msg += fmt::format("#{}: {}\n", i, GetOriginString(sample));
+ }
+ }
+
+ Logger::LogVolatile(logger_,
+ LogLevel::Progress,
+ "{}{} {} cached, {} processing.",
+ now_msg,
+ counter,
+ state_.cached,
+ active);
+ }
+
+ private:
+ gsl::not_null<Statistics*> stats_;
+ gsl::not_null<Progress*> progress_;
+ Logger const* logger_;
+ bool plain_log_{};
+ int count_{};
+ State state_{};
+};
+
+} // namespace
+
auto ProgressReporter::Reporter(gsl::not_null<Statistics*> const& stats,
gsl::not_null<Progress*> const& progress,
- Logger const* logger) noexcept
+ Logger const* logger,
+ bool fancy,
+ LogArguments const& args) noexcept
-> progress_reporter_t {
+ if (fancy) {
+ return BaseProgressReporter::Reporter(
+ FancyReporter{stats, progress, logger, args.plain_log},
+ args.prog_interval,
+ args.prog_backoff_factor);
+ }
return BaseProgressReporter::Reporter([stats, progress, logger]() {
int total = gsl::narrow<int>(progress->OriginMap().size());
int digits = static_cast<int>(log10(total)) + 1;
diff --git a/src/buildtool/progress_reporting/progress_reporter.hpp b/src/buildtool/progress_reporting/progress_reporter.hpp
--- a/src/buildtool/progress_reporting/progress_reporter.hpp
+++ b/src/buildtool/progress_reporting/progress_reporter.hpp
@@ -16,6 +16,7 @@
#define INCLUDED_SRC_BUILDTOOL_PROGRESS_REPORTING_PROGRESS_REPORTER_HPP
#include "gsl/gsl"
+#include "src/buildtool/common/cli.hpp"
#include "src/buildtool/common/statistics.hpp"
#include "src/buildtool/logging/logger.hpp"
#include "src/buildtool/progress_reporting/base_progress_reporter.hpp"
@@ -25,7 +26,9 @@ class ProgressReporter {
public:
[[nodiscard]] static auto Reporter(gsl::not_null<Statistics*> const& stats,
gsl::not_null<Progress*> const& progress,
- Logger const* logger = nullptr) noexcept
+ Logger const* logger = nullptr,
+ bool fancy = false,
+ LogArguments const& args = {}) noexcept
-> progress_reporter_t;
};
diff --git a/src/other_tools/just_mr/cli.hpp b/src/other_tools/just_mr/cli.hpp
--- a/src/other_tools/just_mr/cli.hpp
+++ b/src/other_tools/just_mr/cli.hpp
@@ -66,6 +66,8 @@ struct MultiRepoLogArguments {
std::optional<LogLevel> restrict_stderr_log_limit;
bool plain_log{false};
bool log_append{false};
+ std::size_t prog_interval{kDefaultProgInterval};
+ float prog_backoff_factor{kDefaultProgBackoffFactor};
};
struct MultiRepoSetupArguments {
@@ -101,7 +103,7 @@ struct ForwardOnlyArguments {
std::vector<std::string> remote_execution_properties;
};
-namespace MR { // to avoid clash with backend (just) types
+namespace MR { // to avoid clash with backend (just) types
enum class SubCommand : std::uint8_t {
kUnknown,
@@ -288,13 +290,27 @@ static inline auto SetupMultiRepoLogArguments(
"Restrict logging on console to the minimum of the specified "
"--log-limit and this value")
->type_name("NUM");
- app->add_flag("--plain-log",
- clargs->plain_log,
- "Do not use ANSI escape sequences to highlight messages.");
+ app->add_flag_function(
+ "--plain-log",
+ [clargs](auto /*unused*/) {
+ clargs->plain_log = true;
+ clargs->prog_interval = kDefaultProgIntervalPlain;
+ },
+ "Disable color and interactive progress.");
app->add_flag(
"--log-append",
clargs->log_append,
"Append messages to log file instead of overwriting existing.");
+ app->add_option(
+ "--prog-interval",
+ clargs->prog_interval,
+ fmt::format("Progress message interval in milliseconds (Default {}).",
+ kDefaultProgInterval));
+ app->add_option(
+ "--prog-backoff-factor",
+ clargs->prog_backoff_factor,
+ fmt::format("Progress interval backoff factor (Default {}).",
+ kDefaultProgBackoffFactor));
}
static inline void SetupMultiRepoSetupArguments(
diff --git a/src/other_tools/just_mr/launch.cpp b/src/other_tools/just_mr/launch.cpp
--- a/src/other_tools/just_mr/launch.cpp
+++ b/src/other_tools/just_mr/launch.cpp
@@ -157,6 +157,20 @@ auto CallJust(std::optional<std::filesystem::path> const& config_file,
}
if (log_args.plain_log) {
cmd.emplace_back("--plain-log");
+ if (log_args.prog_interval != kDefaultProgIntervalPlain) {
+ cmd.emplace_back("--prog-interval");
+ cmd.emplace_back(std::to_string(log_args.prog_interval));
+ }
+ }
+ else {
+ if (log_args.prog_interval != kDefaultProgInterval) {
+ cmd.emplace_back("--prog-interval");
+ cmd.emplace_back(std::to_string(log_args.prog_interval));
+ }
+ }
+ if (log_args.prog_backoff_factor != kDefaultProgBackoffFactor) {
+ cmd.emplace_back("--prog-backoff-factor");
+ cmd.emplace_back(std::to_string(log_args.prog_backoff_factor));
}
if (supports_defines) {
if (just_cmd_args.config) {
--