From 7c224674c8ab8277c607962dc547b3f27fee3c2b Mon Sep 17 00:00:00 2001
From: Klaus Aehlig <klaus.aehlig@huawei.com>
Date: Thu, 23 Jan 2025 12:10:12 +0100
Subject: Add basic progress reporter on root evaluation

---
 src/buildtool/computed_roots/TARGETS            | 16 ++++++++
 src/buildtool/computed_roots/roots_progress.cpp | 49 +++++++++++++++++++++++++
 src/buildtool/computed_roots/roots_progress.hpp | 33 +++++++++++++++++
 3 files changed, 98 insertions(+)
 create mode 100644 src/buildtool/computed_roots/roots_progress.cpp
 create mode 100644 src/buildtool/computed_roots/roots_progress.hpp

(limited to 'src')

diff --git a/src/buildtool/computed_roots/TARGETS b/src/buildtool/computed_roots/TARGETS
index a98460b3..c487fe2f 100644
--- a/src/buildtool/computed_roots/TARGETS
+++ b/src/buildtool/computed_roots/TARGETS
@@ -75,6 +75,22 @@
     , ["src/utils/cpp", "hex_string"]
     ]
   }
+, "roots_progress":
+  { "type": ["@", "rules", "CC", "library"]
+  , "name": ["roots_progress"]
+  , "hdrs": ["roots_progress.hpp"]
+  , "srcs": ["roots_progress.cpp"]
+  , "stage": ["src", "buildtool", "computed_roots"]
+  , "deps":
+    [ ["@", "gsl", "", "gsl"]
+    , ["src/buildtool/common", "common"]
+    , ["src/buildtool/logging", "logging"]
+    , ["src/buildtool/progress_reporting", "base_progress_reporter"]
+    , ["src/buildtool/progress_reporting", "task_tracker"]
+    ]
+  , "private-deps":
+    [["@", "fmt", "", "fmt"], ["src/buildtool/logging", "log_level"]]
+  }
 , "evaluate":
   { "type": ["@", "rules", "CC", "library"]
   , "name": ["evaluate"]
diff --git a/src/buildtool/computed_roots/roots_progress.cpp b/src/buildtool/computed_roots/roots_progress.cpp
new file mode 100644
index 00000000..e50876cd
--- /dev/null
+++ b/src/buildtool/computed_roots/roots_progress.cpp
@@ -0,0 +1,49 @@
+// Copyright 2025 Huawei Cloud Computing Technology Co., Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include "src/buildtool/computed_roots/roots_progress.hpp"
+
+#include <functional>
+#include <string>
+
+#include "fmt/core.h"
+#include "src/buildtool/logging/log_level.hpp"
+
+auto RootsProgress::Reporter(gsl::not_null<Statistics*> const& stats,
+                             gsl::not_null<TaskTracker*> const& tasks,
+                             Logger const* logger) noexcept
+    -> progress_reporter_t {
+    return BaseProgressReporter::Reporter([stats, tasks, logger]() {
+        auto const& sample = tasks->Sample();
+        // Note: order matters; queued has to be queried last
+        int cached = stats->ActionsCachedCounter();
+        int run = stats->ActionsExecutedCounter();
+        int served = stats->ExportsServedCounter();
+        int queued = stats->ActionsQueuedCounter();
+        int active = queued - run - cached - served;
+        auto now_msg = std::string{};
+        if (active > 0 and not sample.empty()) {
+            now_msg = fmt::format(" ({}{})", sample, active > 1 ? ", ..." : "");
+        }
+        Logger::Log(
+            logger,
+            LogLevel::Progress,
+            "Computed Roots: {} cached, {} served, {} run, {} processing{}.",
+            cached,
+            served,
+            run,
+            active,
+            now_msg);
+    });
+}
diff --git a/src/buildtool/computed_roots/roots_progress.hpp b/src/buildtool/computed_roots/roots_progress.hpp
new file mode 100644
index 00000000..54032b28
--- /dev/null
+++ b/src/buildtool/computed_roots/roots_progress.hpp
@@ -0,0 +1,33 @@
+// Copyright 2025 Huawei Cloud Computing Technology Co., Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef INCLUDED_SRC_BUILDTOOL_COMPUTED_ROOT_ROOTS_REPORTER_HPP
+#define INCLUDED_SRC_BUILDTOOL_COMPUTED_ROOT_ROOTS_REPORTER_HPP
+
+#include "gsl/gsl"
+#include "src/buildtool/common/statistics.hpp"
+#include "src/buildtool/logging/logger.hpp"
+#include "src/buildtool/progress_reporting/base_progress_reporter.hpp"
+#include "src/buildtool/progress_reporting/task_tracker.hpp"
+
+/// \brief Reporter for progress while computing roots
+class RootsProgress {
+  public:
+    [[nodiscard]] static auto Reporter(gsl::not_null<Statistics*> const& stats,
+                                       gsl::not_null<TaskTracker*> const& tasks,
+                                       Logger const* logger = nullptr) noexcept
+        -> progress_reporter_t;
+};
+
+#endif
-- 
cgit v1.2.3