feat(Examples): Add thread id to AlgorithmContext (acts-project#4236)

paulgessinger · web-flow · commit 4a8645719eb2 · 2025-05-01T07:10:16.000Z
This can help with debugging output, as it can print a more readable value than the native thread id from the standard library.
diff --git a/Examples/Framework/include/ActsExamples/Framework/AlgorithmContext.hpp b/Examples/Framework/include/ActsExamples/Framework/AlgorithmContext.hpp
@@ -24,11 +24,16 @@ struct AlgorithmContext {
   /// @param alg is the algorithm/service/writer number
   /// @param event is the event number
   /// @param store is the event-wise event store
+  /// @param thread is the thread number
   ///
   /// @note the event dependent contexts are to be added by the
   /// Sequencer::m_decorators list
-  AlgorithmContext(std::size_t alg, std::size_t event, WhiteBoard& store)
-      : algorithmNumber(alg), eventNumber(event), eventStore(store) {}
+  AlgorithmContext(std::size_t alg, std::size_t event, WhiteBoard& store,
+                   std::size_t thread)
+      : algorithmNumber(alg),
+        eventNumber(event),
+        eventStore(store),
+        threadId{thread} {}
 
   /// @brief ++operator overload to increase the algorithm number
   AlgorithmContext& operator++() {
@@ -43,6 +48,7 @@ struct AlgorithmContext {
   Acts::MagneticFieldContext
       magFieldContext;                    ///< Per-event magnetic Field context
   Acts::CalibrationContext calibContext;  ///< Per-event calibration context
+  std::size_t threadId;                   ///< Thread ID
 
   Acts::FpeMonitor* fpeMonitor = nullptr;
 };
diff --git a/Examples/Framework/include/ActsExamples/Framework/IWriter.hpp b/Examples/Framework/include/ActsExamples/Framework/IWriter.hpp
@@ -32,7 +32,11 @@ class IWriter : public SequenceElement {
 
   /// Informs the writer that the sequencer will start processing the next
   /// event.
-  virtual ProcessCode beginEvent() { return ProcessCode::SUCCESS; }
+  /// @param threadId The thread ID
+  virtual ProcessCode beginEvent(std::size_t threadId) {
+    static_cast<void>(threadId);
+    return ProcessCode::SUCCESS;
+  }
 
   /// Fulfill the algorithm interface
   ProcessCode initialize() override { return ProcessCode::SUCCESS; }
diff --git a/Examples/Framework/src/Framework/BufferedReader.cpp b/Examples/Framework/src/Framework/BufferedReader.cpp
@@ -43,7 +43,7 @@ BufferedReader::BufferedReader(const Config &config, Acts::Logging::Level level)
   m_buffer.reserve(eend - ebegin);
   for (auto i = ebegin; i < ebegin + m_cfg.bufferSize; ++i) {
     auto board = std::make_unique<ActsExamples::WhiteBoard>(m_logger->clone());
-    ActsExamples::AlgorithmContext ctx(0, i, *board);
+    ActsExamples::AlgorithmContext ctx(0, i, *board, 0);
 
     ACTS_DEBUG("Read event " << i << " into buffer");
     m_cfg.upstreamReader->read(ctx);
diff --git a/Examples/Framework/src/Framework/Sequencer.cpp b/Examples/Framework/src/Framework/Sequencer.cpp
@@ -36,6 +36,7 @@
 #include <stdexcept>
 #include <string>
 #include <string_view>
+#include <thread>
 #include <typeinfo>
 
 #include <TROOT.h>
@@ -390,8 +391,8 @@ int Sequencer::run() {
           for (std::size_t n = r.begin(); n != r.end(); ++n) {
             ACTS_VERBOSE("Thread about to pick next event");
 
-            for (auto& writer : m_writers) {
-              if (writer->beginEvent() != ProcessCode::SUCCESS) {
+            for (const auto& writer : m_writers) {
+              if (writer->beginEvent(threadId) != ProcessCode::SUCCESS) {
                 throw std::runtime_error("Failed to process event data");
               }
             }
@@ -408,7 +409,7 @@ int Sequencer::run() {
                 m_whiteboardObjectAliases);
             // If we ever wanted to run algorithms in parallel, this needs to
             // be changed to Algorithm context copies
-            AlgorithmContext context(0, event, eventStore);
+            AlgorithmContext context(0, event, eventStore, threadId);
             std::size_t ialgo = 0;
 
             /// Decorate the context
diff --git a/Examples/Python/src/Framework.cpp b/Examples/Python/src/Framework.cpp
@@ -21,6 +21,7 @@
 #include <pybind11/stl.h>
 
 namespace py = pybind11;
+using namespace py::literals;
 using namespace ActsExamples;
 using namespace Acts::Python;
 
@@ -120,13 +121,15 @@ void addFramework(Context& ctx) {
       .def_property_readonly("keys", &WhiteBoard::getKeys);
 
   py::class_<AlgorithmContext>(mex, "AlgorithmContext")
-      .def(py::init<std::size_t, std::size_t, WhiteBoard&>())
+      .def(py::init<std::size_t, std::size_t, WhiteBoard&, std::size_t>(),
+           "alg"_a, "event"_a, "store"_a, "thread"_a)
       .def_readonly("algorithmNumber", &AlgorithmContext::algorithmNumber)
       .def_readonly("eventNumber", &AlgorithmContext::eventNumber)
       .def_property_readonly("eventStore",
                              [](const AlgorithmContext& self) -> WhiteBoard& {
                                return self.eventStore;
                              })
+      .def_readonly("threadId", &AlgorithmContext::threadId)
       .def_readonly("magFieldContext", &AlgorithmContext::magFieldContext)
       .def_readonly("geoContext", &AlgorithmContext::geoContext)
       .def_readonly("calibContext", &AlgorithmContext::calibContext)
diff --git a/Examples/Scripts/Python/geometry.py b/Examples/Scripts/Python/geometry.py
@@ -30,8 +30,9 @@ def runGeometry(
     for ievt in range(events):
         eventStore = WhiteBoard(name=f"EventStore#{ievt}", level=acts.logging.INFO)
         ialg = 0
+        ithread = 0
 
-        context = AlgorithmContext(ialg, ievt, eventStore)
+        context = AlgorithmContext(ialg, ievt, eventStore, ithread)
 
         for cdr in decorators:
             r = cdr.decorate(context)
diff --git a/Examples/Scripts/Python/material_mapping.py b/Examples/Scripts/Python/material_mapping.py
@@ -46,7 +46,7 @@ def runMaterialMapping(
 
     wb = WhiteBoard(acts.logging.INFO)
 
-    context = AlgorithmContext(0, 0, wb)
+    context = AlgorithmContext(0, 0, wb, 0)
 
     for decorator in decorators:
         assert decorator.decorate(context) == ProcessCode.SUCCESS
diff --git a/Tests/CommonHelpers/include/Acts/Tests/CommonHelpers/WhiteBoardUtilities.hpp b/Tests/CommonHelpers/include/Acts/Tests/CommonHelpers/WhiteBoardUtilities.hpp
@@ -69,7 +69,7 @@ struct GenericReadWriteTool {
   template <typename writer_t>
   auto write(writer_t &writer, std::size_t eventId = 0) {
     ActsExamples::WhiteBoard board;
-    ActsExamples::AlgorithmContext ctx(0, eventId, board);
+    ActsExamples::AlgorithmContext ctx(0, eventId, board, 0);
 
     auto add = [&](auto &self, auto N) {
       if constexpr (N() < kSize) {
@@ -86,7 +86,7 @@ struct GenericReadWriteTool {
   template <typename reader_t>
   auto read(reader_t &reader, std::size_t eventId = 0) {
     ActsExamples::WhiteBoard board;
-    ActsExamples::AlgorithmContext ctx(0, eventId, board);
+    ActsExamples::AlgorithmContext ctx(0, eventId, board, 0);
 
     reader.internalExecute(ctx);
 
