#2216: Use macro for using correct fmt headers

DARMA-tasking · Dec 12, 2023 · 47aa1b8 · 47aa1b8
1 parent eca2606
commit 47aa1b8
Show file tree

Hide file tree

Showing 41 changed files with 213 additions and 109 deletions.
diff --git a/cmake/configure_options.cmake b/cmake/configure_options.cmake
@@ -154,8 +154,10 @@ define_option(vt_build_examples "examples" "Build VT examples" ON empty_feature)
 option(vt_external_fmt "Build VT with external fmt" OFF)
 if(${vt_external_fmt})
     message(STATUS "Building vt with external fmt library")
+    set(vt_feature_cmake_external_fmt "1")
 else()
     message(STATUS "Building vt with included fmt library")
+    set(vt_feature_cmake_external_fmt "0")
 endif()
 
 list(POP_BACK CMAKE_MESSAGE_INDENT)

diff --git a/cmake/link_vt.cmake b/cmake/link_vt.cmake
@@ -170,9 +170,17 @@ function(link_target_with_vt)
     if (${ARG_DEBUG_LINK})
       message(STATUS "link_target_with_vt: fmt=${ARG_LINK_FMT}")
     endif()
-    target_link_libraries(
-      ${ARG_TARGET} PUBLIC ${ARG_BUILD_TYPE} ${FMT_LIBRARY}
-    )
+
+    if(${vt_external_fmt})
+      target_link_libraries(
+        ${ARG_TARGET} PUBLIC ${ARG_BUILD_TYPE} fmt::fmt
+      )
+    else()
+      target_link_libraries(
+        ${ARG_TARGET} PUBLIC ${ARG_BUILD_TYPE} ${FMT_LIBRARY}
+      )
+    endif()
+
   endif()
 
   if (NOT DEFINED ARG_LINK_ENG_FORMAT AND ${ARG_DEFAULT_LINK_SET} OR ARG_LINK_ENG_FORMAT)

diff --git a/cmake/load_bundled_libraries.cmake b/cmake/load_bundled_libraries.cmake
@@ -23,12 +23,13 @@ add_subdirectory(${PROJECT_LIB_DIR}/CLI)
 # use included fmt or external one
 if(${vt_external_fmt})
   # user should provide 'fmt_DIR' to CMake (unless fmt is installed in system libs)
-  if(${fmt_DIR})
+  if(fmt_DIR)
     message(STATUS "vt_external_fmt = ON. Using fmt located at ${fmt_DIR}")
   else()
-    message(STATUS "vt_external_fmt = ON but ${fmt_DIR} is not provided.")
+    message(STATUS "vt_external_fmt = ON but fmt_DIR is not provided!")
   endif()
   find_package(fmt REQUIRED)
+  # set(FMT_LIBRARY fmt::fmt)
 else()
   set(FMT_LIBRARY fmt)
   add_subdirectory(${PROJECT_LIB_DIR}/fmt)

diff --git a/cmake_config.h.in b/cmake_config.h.in
@@ -65,7 +65,7 @@
 #define vt_feature_cmake_production_build    @vt_feature_cmake_production_build@
 #define vt_feature_cmake_debug_verbose       @vt_feature_cmake_debug_verbose@
 #define vt_feature_cmake_rdma_tests          @vt_feature_cmake_rdma_tests@
-
+#define vt_feature_cmake_external_fmt        @vt_feature_cmake_external_fmt@
 
 #define vt_detected_max_num_nodes @cmake_detected_max_num_nodes@
 
@@ -91,3 +91,15 @@
 #cmakedefine vt_has_sysconf
 #cmakedefine vt_has_libunwind_h
 #cmakedefine vt_has_execinfo_h
+
+#if vt_feature_cmake_external_fmt
+  #define INCLUDE_FMT_CORE <fmt/core.h>
+  #define INCLUDE_FMT_FORMAT <fmt/format.h>
+  #define INCLUDE_FMT_RANGES <fmt/ranges.h>
+  #define INCLUDE_FMT_OSTREAM <fmt/ostream.h>
+#else
+  #define INCLUDE_FMT_CORE <fmt-vt/core.h>
+  #define INCLUDE_FMT_FORMAT <fmt-vt/format.h>
+  #define INCLUDE_FMT_RANGES <fmt-vt/ranges.h>
+  #define INCLUDE_FMT_OSTREAM <fmt-vt/ostream.h>
+#endif
diff --git a/lib/fmt/include/fmt-vt/core.h b/lib/fmt/include/fmt-vt/core.h
@@ -173,8 +173,10 @@
 #ifndef FMT_BEGIN_NAMESPACE
 #  define FMT_BEGIN_NAMESPACE \
     namespace fmt {           \
-    inline namespace v10 {
+    inline namespace v10 {    \
+    inline namespace vt {
 #  define FMT_END_NAMESPACE \
+    }                       \
     }                       \
     }
 #endif

diff --git a/src/vt/configs/debug/debug_fmt.h b/src/vt/configs/debug/debug_fmt.h
@@ -46,7 +46,7 @@
 
 #include "vt/config.h"
 
-#include <fmt-vt/core.h>
+#include INCLUDE_FMT_CORE
 
 #include <iosfwd>
 

diff --git a/src/vt/configs/debug/debug_print.h b/src/vt/configs/debug/debug_print.h
@@ -49,7 +49,7 @@
 #include "vt/configs/debug/debug_colorize.h"
 #include "vt/configs/debug/debug_var_unused.h"
 
-#include <fmt-vt/core.h>
+#include INCLUDE_FMT_CORE
 
 /*
    === Debug file/line/func functionality ===

diff --git a/src/vt/configs/error/assert_out.impl.h b/src/vt/configs/error/assert_out.impl.h
@@ -56,7 +56,7 @@
 #include <string>
 #include <cassert>
 
-#include <fmt-vt/core.h>
+#include INCLUDE_FMT_CORE
 
 namespace vt { namespace debug { namespace assert {
 

diff --git a/src/vt/configs/error/assert_out_info.impl.h b/src/vt/configs/error/assert_out_info.impl.h
@@ -57,7 +57,7 @@
 #include <string>
 #include <sstream>
 
-#include <fmt-vt/core.h>
+#include INCLUDE_FMT_CORE
 
 namespace vt { namespace debug { namespace assert {
 

diff --git a/src/vt/configs/error/error.impl.h b/src/vt/configs/error/error.impl.h
@@ -55,7 +55,7 @@
 #include <tuple>
 #include <type_traits>
 
-#include <fmt-vt/core.h>
+#include INCLUDE_FMT_CORE
 
 namespace vt { namespace error {
 

diff --git a/src/vt/configs/error/keyval_printer.impl.h b/src/vt/configs/error/keyval_printer.impl.h
@@ -53,7 +53,7 @@
 #include <string>
 #include <vector>
 
-#include <fmt-vt/core.h>
+#include INCLUDE_FMT_CORE
 
 namespace vt { namespace util { namespace error {
 

diff --git a/src/vt/configs/error/pretty_print_message.cc b/src/vt/configs/error/pretty_print_message.cc
@@ -50,7 +50,7 @@
 #include <string>
 #include <unistd.h> // gethostname
 
-#include <fmt-vt/core.h>
+#include INCLUDE_FMT_CORE
 
 namespace vt { namespace debug {
 

diff --git a/src/vt/configs/error/soft_error.h b/src/vt/configs/error/soft_error.h
@@ -59,7 +59,7 @@
 
 #include <string>
 
-#include <fmt-vt/core.h>
+#include INCLUDE_FMT_CORE
 
 namespace vt {
 

diff --git a/src/vt/configs/features/features_defines.h b/src/vt/configs/features/features_defines.h
@@ -72,6 +72,7 @@
 #define vt_feature_libfort             0 || vt_feature_cmake_libfort
 #define vt_feature_production_build    0 || vt_feature_cmake_production_build
 #define vt_feature_debug_verbose       0 || vt_feature_cmake_debug_verbose
+#define vt_feature_fmt_external        0 || vt_feature_cmake_external_fmt
 
 #define vt_check_enabled(test_option) (vt_feature_ ## test_option != 0)
 

diff --git a/src/vt/elm/elm_id.h b/src/vt/elm/elm_id.h
@@ -94,7 +94,8 @@ struct hash<vt::elm::ElementIDStruct> {
 
 } /* end namespace std */
 
-#include <fmt-vt/format.h>
+#include "vt/cmake_config.h"
+#include INCLUDE_FMT_FORMAT
 
 namespace fmt {
 

diff --git a/src/vt/epoch/epoch_manip.cc b/src/vt/epoch/epoch_manip.cc
@@ -49,7 +49,7 @@
 #include "vt/utils/bits/bits_packer.h"
 #include "vt/termination/term_common.h"
 
-#include <fmt-vt/ostream.h>
+#include INCLUDE_FMT_OSTREAM
 
 namespace vt { namespace epoch {
 

diff --git a/src/vt/epoch/epoch_type.h b/src/vt/epoch/epoch_type.h
@@ -108,7 +108,8 @@ struct hash<vt::epoch::EpochType> {
 
 } /* end namespace std */
 
-#include <fmt-vt/format.h>
+#include "vt/cmake_config.h"
+#include INCLUDE_FMT_FORMAT
 
 namespace fmt {
 

diff --git a/src/vt/epoch/epoch_window.cc b/src/vt/epoch/epoch_window.cc
@@ -44,7 +44,7 @@
 #include "vt/epoch/epoch_window.h"
 #include "vt/epoch/epoch_manip.h"
 
-#include <fmt-vt/ostream.h>
+#include INCLUDE_FMT_OSTREAM
 
 namespace vt { namespace epoch {
 

diff --git a/src/vt/rdma/rdma_common.h b/src/vt/rdma/rdma_common.h
@@ -117,20 +117,30 @@ static constexpr ByteType rdma_default_byte_size = sizeof(char);
 
 }} //end namespace vt::rdma
 
-template<>
-struct fmt::formatter<vt::rdma::Type> : fmt::formatter<std::string_view> {
+namespace fmt { inline namespace vt {
+template <>
+struct formatter<::vt::rdma::Type> : formatter<std::string_view> {
   template <typename FormatContext>
-  auto format(vt::rdma::Type t, FormatContext& ctx) {
+  auto format(::vt::rdma::Type t, FormatContext& ctx) {
     std::string_view name = "Unknown";
     switch (t) {
-      case vt::rdma::Type::Get: name = "Get"; break;
-      case vt::rdma::Type::Put: name = "Put"; break;
-      case vt::rdma::Type::GetOrPut: name = "GetOrPut"; break;
-      case vt::rdma::Type::Uninitialized: name = "Uninitialized"; break;
+    case ::vt::rdma::Type::Get:
+      name = "Get";
+      break;
+    case ::vt::rdma::Type::Put:
+      name = "Put";
+      break;
+    case ::vt::rdma::Type::GetOrPut:
+      name = "GetOrPut";
+      break;
+    case ::vt::rdma::Type::Uninitialized:
+      name = "Uninitialized";
+      break;
     }
     return formatter<std::string_view>::format(name, ctx);
   }
 };
+}} // namespace fmt::vt
 
 #define PRINT_CHANNEL_TYPE(rdma_op_type) (                              \
   rdma_op_type == vt::rdma::Type::Get ? "rdma::Get" : (            \

diff --git a/src/vt/runtime/component/diagnostic_value_format.h b/src/vt/runtime/component/diagnostic_value_format.h
@@ -49,7 +49,7 @@
 #include "vt/runtime/component/diagnostic_enum_format.h"
 #include "vt/utils/memory/memory_units.h"
 
-#include <fmt-vt/core.h>
+#include INCLUDE_FMT_CORE
 
 namespace vt { namespace runtime { namespace component { namespace detail {
 

diff --git a/src/vt/runtime/runtime_diagnostics.cc b/src/vt/runtime/runtime_diagnostics.cc
@@ -56,7 +56,7 @@
 #include <fort.hpp>
 #endif /*vt_check_enabled(libfort)*/
 
-#include <fmt-vt/core.h>
+#include INCLUDE_FMT_CORE
 
 #include <map>
 #include <string>

diff --git a/src/vt/termination/interval/interval.h b/src/vt/termination/interval/interval.h
@@ -48,7 +48,7 @@
 
 #include <ostream>
 
-#include <fmt-vt/ostream.h>
+#include INCLUDE_FMT_OSTREAM
 
 namespace vt { namespace term { namespace interval {
 
@@ -230,27 +230,25 @@ using Interval = term::interval::Interval<DomainT>;
 
 } /* end namespace vt */
 
-#include <fmt-vt/core.h>
-#include <fmt-vt/format.h>
-
 namespace vt { namespace term { namespace interval {
 
 template <typename DomainT, DomainT sentinel>
 struct Interval;
 
 }}}
 
+namespace fmt { inline namespace vt {
 template <typename DomainT, DomainT sentinel>
-struct fmt::formatter<vt::term::interval::Interval<DomainT, sentinel>> : fmt::formatter<std::string> {
-    template <typename FormatContext>
-    auto format(const vt::term::interval::Interval<DomainT, sentinel>& interval, FormatContext& ctx) {
-        return format_to(
-            ctx.out(),
-            "Interval[{}, {}]",
-            interval.lower(),
-            interval.upper()
-        );
-    }
+struct formatter<::vt::term::interval::Interval<DomainT, sentinel>>
+  : formatter<std::string> {
+  template <typename FormatContext>
+  auto format(
+    const ::vt::term::interval::Interval<DomainT, sentinel>& interval,
+    FormatContext& ctx) {
+    return format_to(
+      ctx.out(), "Interval[{}, {}]", interval.lower(), interval.upper());
+  }
 };
+}} // namespace fmt::vt
 
 #endif /*INCLUDED_VT_TERMINATION_INTERVAL_INTERVAL_H*/
diff --git a/src/vt/timing/timing.h b/src/vt/timing/timing.h
@@ -47,7 +47,8 @@
 #include <string>
 
 #include <EngFormat-Cpp/eng_format.hpp>
-#include <fmt-vt/core.h>
+#include "vt/cmake_config.h"
+#include INCLUDE_FMT_CORE
 
 #include "vt/timing/timing_type.h"
 
@@ -62,24 +63,22 @@ TimeType getCurrentTime();
 
 }} /* end namespace vt::timing */
 
-namespace fmt {
-
-template<>
+namespace fmt { inline namespace vt {
+template <>
 struct formatter<::vt::TimeTypeWrapper> {
-  template<typename ParseContext>
+  template <typename ParseContext>
   constexpr auto parse(ParseContext& ctx) {
     return ctx.begin();
   }
 
-  template<typename FormatContext>
+  template <typename FormatContext>
   auto format(::vt::TimeTypeWrapper const& t, FormatContext& ctx) {
     return fmt::format_to(
       ctx.out(), "{}",
-      to_engineering_string(t.seconds(), 3, eng_exponential, "s")
-    );
+      to_engineering_string(t.seconds(), 3, eng_exponential, "s"));
   }
 };
 
-} /* end namespace fmt */
+}} // namespace fmt::vt
 
 #endif /*INCLUDED_VT_TIMING_TIMING_H*/
diff --git a/src/vt/topos/index/dense/dense_array.h b/src/vt/topos/index/dense/dense_array.h
@@ -49,6 +49,7 @@
 #include "vt/utils/bits/bits_packer.h"
 #include "vt/utils/static_checks/meta_type_eq_.h"
 #include "vt/serialization/traits/byte_copy_trait.h"
+#include INCLUDE_FMT_RANGES
 
 #include <array>
 #include <type_traits>
@@ -146,6 +147,7 @@ struct DenseIndexArray : BaseIndex, serialization::ByteCopyTrait {
     std::ostream& os, DenseIndexArray<IndexT,nd> const& idx
   );
 
+  friend struct fmt::formatter<vt::index::DenseIndexArray<IndexType, ndim>>;
 private:
   std::array<IndexType, ndim> dims = {};
 };
@@ -157,15 +159,19 @@ static_assert(
 
 }}  // end namespace vt::index
 
+namespace fmt { inline namespace vt {
 
-template <typename IndexType, vt::index::NumDimensionsType ndim>
-struct fmt::formatter<vt::index::DenseIndexArray<IndexType, ndim>> : fmt::formatter<std::string> {
+template <typename IndexType, ::vt::index::NumDimensionsType ndim>
+struct formatter<::vt::index::DenseIndexArray<IndexType, ndim>>
+  : formatter<std::array<IndexType, ndim>> {
   template <typename FormatContext>
-  auto format(const vt::index::DenseIndexArray<IndexType, ndim>& idx, FormatContext& ctx) {
-    return formatter<std::string>::format(idx.toString(), ctx);
+  auto format(
+    const ::vt::index::DenseIndexArray<IndexType, ndim>& wrapper,
+    FormatContext& ctx) {
+    return formatter<std::array<IndexType, ndim>>::format(wrapper.dims, ctx);
   }
 };
-
+}} // namespace fmt::vt
 
 #include "vt/topos/index/dense/dense_array.impl.h"
 

diff --git a/src/vt/utils/adt/histogram_approx.h b/src/vt/utils/adt/histogram_approx.h
@@ -52,7 +52,7 @@
 #include <cmath>
 #include <algorithm>
 
-#include <fmt-vt/core.h>
+#include INCLUDE_FMT_CORE
 
 namespace vt { namespace util { namespace adt {