Merge pull request #6330 from STEllAR-GROUP/collective_logging

Adding basic logging to collective operations

libs/full/collectives/include/hpx/collectives/all_gather.hpp

@@ -131,6 +131,12 @@ namespace hpx::traits {
 
     namespace communication {
         struct all_gather_tag;
+
+        template <>
+        constexpr char const* communicator_name<all_gather_tag>() noexcept
+        {
+            return "all_gather";
+        }
     }    // namespace communication
 
     ///////////////////////////////////////////////////////////////////////////

libs/full/collectives/include/hpx/collectives/all_reduce.hpp

@@ -136,7 +136,14 @@ namespace hpx { namespace collectives {
 namespace hpx::traits {
 
     namespace communication {
+
         struct all_reduce_tag;
+
+        template <>
+        constexpr char const* communicator_name<all_reduce_tag>() noexcept
+        {
+            return "all_reduce";
+        }
     }    // namespace communication
 
     ///////////////////////////////////////////////////////////////////////////

libs/full/collectives/include/hpx/collectives/all_to_all.hpp

@@ -130,7 +130,14 @@ namespace hpx { namespace collectives {
 namespace hpx::traits {
 
     namespace communication {
+
         struct all_to_all_tag;
+
+        template <>
+        constexpr char const* communicator_name<all_to_all_tag>() noexcept
+        {
+            return "all_to_all";
+        }
     }    // namespace communication
 
     ///////////////////////////////////////////////////////////////////////////

libs/full/collectives/include/hpx/collectives/broadcast.hpp

@@ -213,7 +213,14 @@ namespace hpx::traits {
     ///////////////////////////////////////////////////////////////////////////
     // support for broadcast
     namespace communication {
+
         struct broadcast_tag;
+
+        template <>
+        constexpr char const* communicator_name<broadcast_tag>() noexcept
+        {
+            return "broadcast";
+        }
     }    // namespace communication
 
     template <typename Communicator>

libs/full/collectives/include/hpx/collectives/create_communicator.hpp

@@ -102,18 +102,15 @@ namespace hpx::collectives::detail {
     };
 }    // namespace hpx::collectives::detail
 
-namespace hpx::util {
-
-    // This is explicitly instantiated to ensure that the id is stable across
-    // shared libraries.
-    template <>
-    struct extra_data_helper<collectives::detail::communicator_data>
-    {
-        HPX_EXPORT static extra_data_id_type id() noexcept;
-        static constexpr void reset(
-            collectives::detail::communicator_data*) noexcept {};
-    };
-}    // namespace hpx::util
+// This is explicitly instantiated to ensure that the id is stable across
+// shared libraries.
+template <>
+struct hpx::util::extra_data_helper<hpx::collectives::detail::communicator_data>
+{
+    HPX_EXPORT static extra_data_id_type id() noexcept;
+    static constexpr void reset(
+        collectives::detail::communicator_data*) noexcept {};
+};    // namespace hpx::util
 
 namespace hpx::collectives {
 

libs/full/collectives/include/hpx/collectives/detail/communicator.hpp

@@ -16,6 +16,7 @@
 #include <hpx/datastructures/any.hpp>
 #include <hpx/futures/future.hpp>
 #include <hpx/lcos_local/and_gate.hpp>
+#include <hpx/modules/logging.hpp>
 #include <hpx/synchronization/spinlock.hpp>
 #include <hpx/thread_support/assert_owns_lock.hpp>
 #include <hpx/type_support/unused.hpp>
@@ -31,6 +32,16 @@ namespace hpx::traits {
     // This type can be specialized for a particular collective operation
     template <typename Communicator, typename Operation>
     struct communication_operation;
+
+    namespace communication {
+
+        // Retrieve name of the current communicator
+        template <typename Operation>
+        constexpr char const* communicator_name() noexcept
+        {
+            return "<unknown>";
+        }
+    }    // namespace communication
 }    // namespace hpx::traits
 
 namespace hpx::collectives::detail {
@@ -55,6 +66,11 @@ namespace hpx::collectives::detail {
             using collective_operation =
                 traits::communication_operation<communicator_server, Operation>;
 
+            LHPX_(info, " [COL] ")
+                .format("get({}): which({}), generation({})",
+                    traits::communication::communicator_name<Operation>(),
+                    which, generation);
+
             return collective_operation::template get<Result>(
                 *this, which, generation, HPX_MOVE(args)...);
         }
@@ -75,6 +91,11 @@ namespace hpx::collectives::detail {
             using collective_operation =
                 traits::communication_operation<communicator_server, Operation>;
 
+            LHPX_(info, " [COL] ")
+                .format("set({}): which({}), generation({})",
+                    traits::communication::communicator_name<Operation>(),
+                    which, generation);
+
             return collective_operation::template set<Result>(
                 *this, which, generation, HPX_MOVE(args)...);
         }

libs/full/collectives/include/hpx/collectives/exclusive_scan.hpp

@@ -148,7 +148,14 @@ namespace hpx { namespace collectives {
 namespace hpx::traits {
 
     namespace communication {
+
         struct exclusive_scan_tag;
+
+        template <>
+        constexpr char const* communicator_name<exclusive_scan_tag>() noexcept
+        {
+            return "exclusive_scan";
+        }
     }    // namespace communication
 
     ///////////////////////////////////////////////////////////////////////////

libs/full/collectives/include/hpx/collectives/gather.hpp

@@ -234,6 +234,12 @@ namespace hpx::traits {
     namespace communication {
 
         struct gather_tag;
+
+        template <>
+        constexpr char const* communicator_name<gather_tag>() noexcept
+        {
+            return "gather";
+        }
     }    // namespace communication
 
     template <typename Communicator>

libs/full/collectives/include/hpx/collectives/inclusive_scan.hpp

@@ -138,6 +138,12 @@ namespace hpx::traits {
     namespace communication {
 
         struct inclusive_scan_tag;
+
+        template <>
+        constexpr char const* communicator_name<inclusive_scan_tag>() noexcept
+        {
+            return "inclusive_scan";
+        }
     }    // namespace communication
 
     ///////////////////////////////////////////////////////////////////////////

libs/full/collectives/include/hpx/collectives/reduce.hpp

@@ -235,6 +235,12 @@ namespace hpx::traits {
     namespace communication {
 
         struct reduce_tag;
+
+        template <>
+        constexpr char const* communicator_name<reduce_tag>() noexcept
+        {
+            return "reduce";
+        }
     }    // namespace communication
 
     ///////////////////////////////////////////////////////////////////////////

libs/full/collectives/include/hpx/collectives/scatter.hpp

@@ -227,6 +227,12 @@ namespace hpx::traits {
     namespace communication {
 
         struct scatter_tag;
+
+        template <>
+        constexpr char const* communicator_name<scatter_tag>() noexcept
+        {
+            return "scatter";
+        }
     }    // namespace communication
 
     template <typename Communicator>