Add logging to all traccc algorithms

This commit adds ACTS-style loggers to all existing traccc algorithms,
and requires that all future algorithms have the same. It also carefully
threads logger objects through the computation chain. Currently, little
is added in the way of useful logging outputs, as that can happen in a
future commit: this is just infrastructure.

Author: stephenswat

CMakeLists.txt

@@ -370,6 +370,20 @@ option( TRACCC_ENABLE_NVTX_PROFILING
 # option for algebra plugins (ARRAY EIGEN SMATRIX VC VECMEM)
 set(TRACCC_ALGEBRA_PLUGINS ARRAY CACHE STRING "Algebra plugin to use in the build")
 
+# Set up either the ACTS or traccc logger.
+if(TRACCC_SETUP_ACTS OR TARGET ActsCore)
+   message(STATUS "Enabling the ACTS logger, because ACTS is set to be enabled or already exists.")
+   set(TRACCC_USE_ACTS_LOGGER ON)
+else()
+   set(TRACCC_USE_ACTS_LOGGER OFF)
+endif()
+
+if(TRACCC_USE_ACTS_LOGGER)
+   message(STATUS "Building traccc with the ACTS logger")
+else()
+   message(STATUS "Building traccc with the built-in logger")
+endif()
+
 # Build the traccc code.
 add_subdirectory( core )
 add_subdirectory( device/common )

core/CMakeLists.txt

@@ -44,6 +44,7 @@ traccc_add_library( traccc_core core TYPE SHARED
   "include/traccc/utils/memory_resource.hpp"
   "include/traccc/utils/seed_generator.hpp"
   "include/traccc/utils/subspace.hpp"
+  "src/utils/logging.cpp"
   # Clusterization algorithmic code.
   "include/traccc/clusterization/details/sparse_ccl.hpp"
   "include/traccc/clusterization/impl/sparse_ccl.ipp"
@@ -118,6 +119,11 @@ target_link_libraries( traccc_core
   PUBLIC Eigen3::Eigen vecmem::core detray::core detray::detectors
          traccc::algebra )
 
+if(TRACCC_USE_ACTS_LOGGER)
+  target_link_libraries(traccc_core PUBLIC ActsCore)
+  target_compile_definitions(traccc_core PUBLIC TRACCC_USE_ACTS_LOGGER)
+endif()
+
 # Prevent Eigen from getting confused when building code for a
 # CUDA or HIP backend with SYCL.
 target_compile_definitions( traccc_core

core/include/traccc/ambiguity_resolution/greedy_ambiguity_resolution_algorithm.hpp

@@ -25,6 +25,7 @@
 #include "traccc/edm/track_candidate.hpp"
 #include "traccc/edm/track_state.hpp"
 #include "traccc/utils/algorithm.hpp"
+#include "traccc/utils/logging.hpp"
 
 // Greedy ambiguity resolution adapted from ACTS code
 
@@ -110,8 +111,10 @@ class greedy_ambiguity_resolution_algorithm
     /// @param cfg  Configuration object
     // greedy_ambiguity_resolution_algorithm(const config_type& cfg) :
     // _config(cfg) {}
-    greedy_ambiguity_resolution_algorithm(const config_t cfg = {})
-        : _config{cfg} {}
+    greedy_ambiguity_resolution_algorithm(
+        const config_t cfg,
+        std::unique_ptr<const Logger> logger = getDummyLogger().clone())
+        : _config{cfg}, _logger{std::move(logger)} {}
 
     /// Run the algorithm
     ///
@@ -156,6 +159,10 @@ class greedy_ambiguity_resolution_algorithm
         state_t& final_state) const;
 
     config_t _config;
+
+    std::unique_ptr<const Logger> _logger;
+
+    const Logger& logger() const override { return *_logger; }
 };
 
 }  // namespace traccc

core/include/traccc/clusterization/clusterization_algorithm.hpp

@@ -41,7 +41,9 @@ class clusterization_algorithm
     ///
     /// @param mr The memory resource to use for the result objects
     ///
-    clusterization_algorithm(vecmem::memory_resource& mr);
+    clusterization_algorithm(
+        vecmem::memory_resource& mr,
+        std::unique_ptr<const Logger> logger = getDummyLogger().clone());
 
     /// Construct measurements for each detector module
     ///
@@ -68,6 +70,14 @@ class clusterization_algorithm
     /// Reference to the host-accessible memory resource
     std::reference_wrapper<vecmem::memory_resource> m_mr;
 
+    /// Algorithm-specific logger object
+    std::unique_ptr<const Logger> m_logger;
+
+    /// Logger access method
+    const Logger& logger() const override {
+        assert(m_logger.get() != nullptr);
+        return *m_logger;
+    }
 };  // class clusterization_algorithm
 
 }  // namespace traccc::host

core/include/traccc/clusterization/measurement_creation_algorithm.hpp

@@ -39,7 +39,9 @@ class measurement_creation_algorithm
     ///
     /// @param mr The memory resource to use in the algorithm
     ///
-    measurement_creation_algorithm(vecmem::memory_resource &mr);
+    measurement_creation_algorithm(
+        vecmem::memory_resource &mr,
+        std::unique_ptr<const Logger> logger = getDummyLogger().clone());
 
     /// Callable operator for the connected component, based on one single
     /// module
@@ -58,6 +60,15 @@ class measurement_creation_algorithm
     /// The memory resource used by the algorithm
     std::reference_wrapper<vecmem::memory_resource> m_mr;
 
+    /// Algorithm-specific logger object
+    std::unique_ptr<const Logger> m_logger;
+
+    /// Logger access method
+    const Logger &logger() const override {
+        assert(m_logger.get() != nullptr);
+        return *m_logger;
+    }
+
 };  // class measurement_creation_algorithm
 
 }  // namespace traccc::host

core/include/traccc/clusterization/measurement_sorting_algorithm.hpp

@@ -36,6 +36,14 @@ class measurement_sorting_algorithm
     output_type operator()(const measurement_collection_types::view&
                                measurements_view) const override;
 
+    /// Algorithm-specific logger object
+    std::unique_ptr<const Logger> m_logger;
+
+    /// Logger access method
+    const Logger& logger() const override {
+        assert(m_logger.get() != nullptr);
+        return *m_logger;
+    }
 };  // class measurement_sorting_algorithm
 
 }  // namespace traccc::host

core/include/traccc/clusterization/sparse_ccl_algorithm.hpp

@@ -34,7 +34,9 @@ class sparse_ccl_algorithm
     ///
     /// @param mr is the memory resource
     ///
-    sparse_ccl_algorithm(vecmem::memory_resource& mr);
+    sparse_ccl_algorithm(
+        vecmem::memory_resource& mr,
+        std::unique_ptr<const Logger> logger = getDummyLogger().clone());
 
     /// @name Operator(s) to use in host code
     /// @{
@@ -54,6 +56,14 @@ class sparse_ccl_algorithm
     /// The memory resource used by the algorithm
     std::reference_wrapper<vecmem::memory_resource> m_mr;
 
+    /// Algorithm-specific logger object
+    std::unique_ptr<const Logger> m_logger;
+
+    /// Logger access method
+    const Logger& logger() const override {
+        assert(m_logger.get() != nullptr);
+        return *m_logger;
+    }
 };  // class sparse_ccl_algorithm
 
 }  // namespace traccc::host

core/include/traccc/finding/combinatorial_kalman_filter_algorithm.hpp

@@ -46,7 +46,9 @@ class combinatorial_kalman_filter_algorithm
     using output_type = track_candidate_container_types::host;
 
     /// Constructor with the algorithm's configuration
-    explicit combinatorial_kalman_filter_algorithm(const config_type& config);
+    explicit combinatorial_kalman_filter_algorithm(
+        const config_type& config,
+        std::unique_ptr<const Logger> logger = getDummyLogger().clone());
 
     /// Execute the algorithm
     ///
@@ -88,6 +90,14 @@ class combinatorial_kalman_filter_algorithm
     /// Algorithm configuration
     config_type m_config;
 
+    /// Algorithm-specific logger object
+    std::unique_ptr<const Logger> m_logger;
+
+    /// Logger access method
+    const Logger& logger() const override {
+        assert(m_logger.get() != nullptr);
+        return *m_logger;
+    }
 };  // class combinatorial_kalman_filter_algorithm
 
 }  // namespace traccc::host

core/include/traccc/fitting/kalman_fitting_algorithm.hpp

@@ -48,8 +48,9 @@ class kalman_fitting_algorithm
     ///
     /// @param config The configuration object
     ///
-    explicit kalman_fitting_algorithm(const config_type& config,
-                                      vecmem::memory_resource& mr);
+    explicit kalman_fitting_algorithm(
+        const config_type& config, vecmem::memory_resource& mr,
+        std::unique_ptr<const Logger> logger = getDummyLogger().clone());
 
     /// Execute the algorithm
     ///
@@ -87,6 +88,14 @@ class kalman_fitting_algorithm
     /// Memory resource to use in the algorithm
     std::reference_wrapper<vecmem::memory_resource> m_mr;
 
+    /// Algorithm-specific logger object
+    std::unique_ptr<const Logger> m_logger;
+
+    /// Logger access method
+    const Logger& logger() const override {
+        assert(m_logger.get() != nullptr);
+        return *m_logger;
+    }
 };  // class kalman_fitting_algorithm
 
 }  // namespace traccc::host

core/include/traccc/seeding/doublet_finding.hpp

@@ -32,7 +32,10 @@ struct doublet_finding
     ///
     /// @param seedfinder_config is the configuration parameters
     /// @param isp_container is the internal spacepoint container
-    doublet_finding(const seedfinder_config& config) : m_config(config) {}
+    doublet_finding(
+        const seedfinder_config& config,
+        std::unique_ptr<const Logger> logger = getDummyLogger().clone())
+        : m_config(config), m_logger(std::move(logger)) {}
 
     /// Callable operator for doublet finding per middle spacepoint
     ///
@@ -99,6 +102,15 @@ struct doublet_finding
 
     private:
     seedfinder_config m_config;
+
+    /// Algorithm-specific logger object
+    std::unique_ptr<const Logger> m_logger;
+
+    /// Logger access method
+    const Logger& logger() const override {
+        assert(m_logger.get() != nullptr);
+        return *m_logger;
+    }
 };
 
 }  // namespace traccc

core/include/traccc/seeding/seed_filtering.hpp

@@ -13,6 +13,7 @@
 #include "traccc/seeding/detail/seeding_config.hpp"
 #include "traccc/seeding/detail/spacepoint_grid.hpp"
 #include "traccc/seeding/detail/triplet.hpp"
+#include "traccc/utils/logging.hpp"
 
 namespace traccc {
 
@@ -21,7 +22,9 @@ class seed_filtering {
 
     public:
     /// Constructor with the seed filter configuration
-    seed_filtering(const seedfilter_config& config);
+    seed_filtering(
+        const seedfilter_config& config,
+        std::unique_ptr<const Logger> logger = getDummyLogger().clone());
 
     /// Callable operator for the seed filtering
     ///
@@ -40,6 +43,14 @@ class seed_filtering {
     /// Seed filter configuration
     seedfilter_config m_filter_config;
 
+    /// Algorithm-specific logger object
+    std::unique_ptr<const Logger> m_logger;
+
+    /// Logger access method
+    const Logger& logger() const {
+        assert(m_logger.get() != nullptr);
+        return *m_logger;
+    }
 };  // class seed_filtering
 
 }  // namespace traccc

core/include/traccc/seeding/seed_finding.hpp

@@ -30,8 +30,10 @@ class seed_finding
     /// @param find_config is seed finder configuration parameters
     /// @param filter_config is the seed filter configuration
     ///
-    seed_finding(const seedfinder_config& find_config,
-                 const seedfilter_config& filter_config);
+    seed_finding(
+        const seedfinder_config& find_config,
+        const seedfilter_config& filter_config,
+        std::unique_ptr<const Logger> logger = getDummyLogger().clone());
 
     /// Callable operator for the seed finding
     ///
@@ -53,6 +55,14 @@ class seed_finding
     /// Algorithm performing the seed selection
     seed_filtering m_seed_filtering;
 
+    /// Algorithm-specific logger object
+    std::unique_ptr<const Logger> m_logger;
+
+    /// Logger access method
+    const Logger& logger() const override {
+        assert(m_logger.get() != nullptr);
+        return *m_logger;
+    }
 };  // class seed_finding
 
 }  // namespace traccc

core/include/traccc/seeding/seeding_algorithm.hpp

@@ -28,10 +28,11 @@ class seeding_algorithm : public algorithm<seed_collection_types::host(
     ///
     /// @param mr The memory resource to use
     ///
-    seeding_algorithm(const seedfinder_config& finder_config,
-                      const spacepoint_grid_config& grid_config,
-                      const seedfilter_config& filter_config,
-                      vecmem::memory_resource& mr);
+    seeding_algorithm(
+        const seedfinder_config& finder_config,
+        const spacepoint_grid_config& grid_config,
+        const seedfilter_config& filter_config, vecmem::memory_resource& mr,
+        std::unique_ptr<const Logger> logger = getDummyLogger().clone());
 
     /// Operator executing the algorithm.
     ///
@@ -47,6 +48,15 @@ class seeding_algorithm : public algorithm<seed_collection_types::host(
     /// Sub-algorithm performing the seed finding
     seed_finding m_seed_finding;
 
+    /// Algorithm-specific logger object
+    std::unique_ptr<const Logger> m_logger;
+
+    /// Logger access method
+    const Logger& logger() const override {
+        assert(m_logger.get() != nullptr);
+        return *m_logger;
+    }
+
 };  // class seeding_algorithm
 
 }  // namespace traccc

core/include/traccc/seeding/silicon_pixel_spacepoint_formation_algorithm.hpp

@@ -42,7 +42,9 @@ class silicon_pixel_spacepoint_formation_algorithm
     ///
     /// @param mr is the memory resource
     ///
-    silicon_pixel_spacepoint_formation_algorithm(vecmem::memory_resource& mr);
+    silicon_pixel_spacepoint_formation_algorithm(
+        vecmem::memory_resource& mr,
+        std::unique_ptr<const Logger> logger = getDummyLogger().clone());
 
     /// Construct spacepoints from 2D silicon pixel measurements
     ///
@@ -70,6 +72,14 @@ class silicon_pixel_spacepoint_formation_algorithm
     /// Memory resource to use for the output container
     std::reference_wrapper<vecmem::memory_resource> m_mr;
 
+    /// Algorithm-specific logger object
+    std::unique_ptr<const Logger> m_logger;
+
+    /// Logger access method
+    const Logger& logger() const override {
+        assert(m_logger.get() != nullptr);
+        return *m_logger;
+    }
 };  // class silicon_pixel_spacepoint_formation_algorithm
 
 }  // namespace traccc::host

core/include/traccc/seeding/spacepoint_binning.hpp

@@ -29,9 +29,10 @@ class spacepoint_binning
     /// @param grid_config is for spacepoint grid parameter
     /// @param mr is the vecmem memory resource
     ///
-    spacepoint_binning(const seedfinder_config& config,
-                       const spacepoint_grid_config& grid_config,
-                       vecmem::memory_resource& mr);
+    spacepoint_binning(
+        const seedfinder_config& config,
+        const spacepoint_grid_config& grid_config, vecmem::memory_resource& mr,
+        std::unique_ptr<const Logger> logger = getDummyLogger().clone());
 
     /// Operator executing the algorithm
     ///
@@ -46,6 +47,15 @@ class spacepoint_binning
     spacepoint_grid_config m_grid_config;
     std::pair<output_type::axis_p0_type, output_type::axis_p1_type> m_axes;
     std::reference_wrapper<vecmem::memory_resource> m_mr;
+
+    /// Algorithm-specific logger object
+    std::unique_ptr<const Logger> m_logger;
+
+    /// Logger access method
+    const Logger& logger() const override {
+        assert(m_logger.get() != nullptr);
+        return *m_logger;
+    }
 };
 
 }  // namespace traccc