Allow mixing debug and release builds

.github/workflows/windows_debug.yml

@@ -39,9 +39,29 @@ jobs:
       run: |
           cmake --build build --config Debug \
           --target ALL_BUILD \
-            cmake_build_dir_targets_test.make_compile \
-            cmake_build_dir_macros_test.make_compile \
+            cmake_debug_build_dir_targets_test.make_build_dir \
+            cmake_debug_build_dir_targets_test.make_configure \
+            cmake_debug_build_dir_targets_test.make_compile   \
+            cmake_debug_build_dir_macros_test.make_build_dir \
+            cmake_debug_build_dir_macros_test.make_configure \
+            cmake_debug_build_dir_macros_test.make_compile   \
           -- -maxcpucount -verbosity:minimal -nologo
+    - name: Install
+      shell: bash
+      run: |
+          cmake --install build --config Debug
+    - name: Build External
+      shell: bash
+      run: |
+          cmake --build build --config Debug \
+            --target \
+              cmake_debug_install_dir_targets_test.make_build_dir \
+              cmake_debug_install_dir_targets_test.make_configure \
+              cmake_debug_install_dir_targets_test.make_compile   \
+              cmake_debug_install_dir_macros_test.make_build_dir \
+              cmake_debug_install_dir_macros_test.make_configure \
+              cmake_debug_install_dir_macros_test.make_compile   \
+            -- -maxcpucount -verbosity:minimal -nologo
     - name: Test
       shell: bash
       run: |

.github/workflows/windows_release.yml

@@ -38,19 +38,28 @@ jobs:
       run: |
           cmake --build build --config Release \
           --target ALL_BUILD \
-            cmake_build_dir_targets_test.make_compile \
-            cmake_build_dir_macros_test.make_compile \
+            cmake_release_build_dir_targets_test.make_build_dir \
+            cmake_release_build_dir_targets_test.make_configure \
+            cmake_release_build_dir_targets_test.make_compile   \
+            cmake_release_build_dir_macros_test.make_build_dir \
+            cmake_release_build_dir_macros_test.make_configure \
+            cmake_release_build_dir_macros_test.make_compile   \
           -- -maxcpucount -verbosity:minimal -nologo
     - name: Install
       shell: bash
       run: |
-          cmake --install build
+          cmake --install build --config Release
     - name: Build External
       shell: bash
       run: |
           cmake --build build --config Release \
-            --target cmake_install_dir_targets_test.make_compile \
-              cmake_install_dir_macros_test.make_compile \
+            --target \
+              cmake_release_install_dir_targets_test.make_build_dir \
+              cmake_release_install_dir_targets_test.make_configure \
+              cmake_release_install_dir_targets_test.make_compile   \
+              cmake_release_install_dir_macros_test.make_build_dir \
+              cmake_release_install_dir_macros_test.make_configure \
+              cmake_release_install_dir_macros_test.make_compile   \
             -- -maxcpucount -verbosity:minimal -nologo
     - name: Test
       shell: bash

CMakeLists.txt

@@ -1730,23 +1730,6 @@ hpx_option(
   ADVANCED
 )
 
-# ##############################################################################
-# Add necessary compiler flags. Flags added here include flags to disable/enable
-# certain warnings, enabling C++11 mode and disabling asserts. Setting of
-# optimization flags is not handled here and is left to the responsibility of
-# the user to avoid conflicts in the resulting binaries
-
-hpx_add_target_compile_definition(_DEBUG PUBLIC CONFIGURATIONS Debug)
-hpx_add_target_compile_definition(DEBUG PUBLIC CONFIGURATIONS Debug)
-hpx_add_target_compile_definition(
-  HPX_DISABLE_ASSERTS PUBLIC CONFIGURATIONS Release RelWithDebInfo
-                                            MinSizeRelease
-)
-hpx_add_target_compile_definition(
-  BOOST_DISABLE_ASSERTS PUBLIC CONFIGURATIONS Release RelWithDebInfo
-                                              MinSizeRelease
-)
-
 # ##############################################################################
 # C++ feature tests
 # ##############################################################################
@@ -1853,7 +1836,7 @@ if(WIN32)
     # non-referenced functions and data (-Zc:inline)
     hpx_add_target_compile_option(-Zc:inline PUBLIC)
     hpx_add_target_compile_option(
-      -Gw PUBLIC CONFIGURATIONS Release RelWithDebInfo MinSizeRelease
+      -Gw PUBLIC CONFIGURATIONS Release RelWithDebInfo MinSizeRel
     )
     hpx_add_target_compile_option(-Zo PUBLIC CONFIGURATIONS RelWithDebInfo)
     if(HPX_WITH_DATAPAR_VC)

cmake/HPX_AddModule.cmake

@@ -319,9 +319,7 @@ function(add_hpx_module libname modulename)
   endif()
 
   target_compile_definitions(
-    hpx_${modulename}
-    PRIVATE $<$<CONFIG:Debug>:DEBUG> $<$<CONFIG:Debug>:_DEBUG>
-            HPX_${libname_upper}_EXPORTS
+    hpx_${modulename} PRIVATE HPX_${libname_upper}_EXPORTS
   )
 
   # This is a temporary solution until all of HPX has been modularized as it

cmake/HPX_CompilerFlagsTargets.cmake

@@ -21,6 +21,13 @@ target_compile_definitions(
   hpx_public_flags INTERFACE $<$<CONFIG:Debug>:HPX_DEBUG>
 )
 
+target_compile_definitions(
+  hpx_private_flags
+  INTERFACE $<$<CONFIG:MinSizeRel>:NDEBUG>
+  INTERFACE $<$<CONFIG:Release>:NDEBUG>
+  INTERFACE $<$<CONFIG:RelWithDebInfo>:NDEBUG>
+)
+
 # Remaining flags are set through the macros in cmake/HPX_AddCompileFlag.cmake
 
 include(HPX_ExportTargets)

cmake/templates/HPXConfig.cmake.in

@@ -98,7 +98,6 @@ if(NOT HPX_CMAKE_LOGLEVEL)
   set(HPX_CMAKE_LOGLEVEL "WARN")
 endif()
 
-hpx_check_cmake_build_type()
 hpx_check_compiler_compatibility()
 hpx_check_boost_compatibility()
 hpx_check_allocator_compatibility()

cmake/templates/HPXMacros.cmake.in

@@ -95,25 +95,3 @@ function(hpx_check_allocator_compatibility)
       "informational purposes to dependent projects and should not be changed.")
   endif()
 endfunction()
-
-# Check we are using the same build type as HPX
-function(hpx_check_cmake_build_type)
-  get_property(_GENERATOR_IS_MULTI_CONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
-  if (NOT _GENERATOR_IS_MULTI_CONFIG AND
-      NOT "${HPX_BUILD_TYPE}" STREQUAL "${CMAKE_BUILD_TYPE}" AND
-      ("${HPX_BUILD_TYPE}" STREQUAL "Debug" OR "${CMAKE_BUILD_TYPE}" STREQUAL "Debug"))
-    if(HPX_IGNORE_CMAKE_BUILD_TYPE_COMPATIBILITY)
-      hpx_warn("CMAKE_BUILD_TYPE does not match ${HPX_BUILD_TYPE}: "
-        "this project uses '${CMAKE_BUILD_TYPE}', HPX uses '${HPX_BUILD_TYPE}'. "
-        "HPX is not ABI compatible between release and debug modes and it is "
-        "recommended that you use the same build type for HPX and your project.")
-    else()
-      hpx_error("CMAKE_BUILD_TYPE does not match ${HPX_BUILD_TYPE}: "
-        "this project uses '${CMAKE_BUILD_TYPE}', HPX uses '${HPX_BUILD_TYPE}'. "
-        "Please add -DCMAKE_BUILD_TYPE=${HPX_BUILD_TYPE} to your cmake command "
-        "or add -DHPX_IGNORE_CMAKE_BUILD_TYPE_COMPATIBILITY=ON to ignore this "
-        "check (not recommended; HPX is not ABI compatible between release and "
-        "debug modes).")
-    endif()
-  endif()
-endfunction()

examples/hello_world_component/CMakeLists.txt

@@ -15,7 +15,6 @@ if(EXISTS "${HPX_DIR}")
 
   add_executable(hello_world_client hello_world_client.cpp)
   target_include_directories(hello_world_client PRIVATE ${test_SOURCE_DIR})
-  target_include_directories(hello_world_client PRIVATE HPX_DEBUG)
 
   if("${SETUP_TYPE}" STREQUAL "TARGETS")
     target_link_libraries(
@@ -36,9 +35,6 @@ if(EXISTS "${HPX_DIR}")
       target_include_directories(
         hello_world_client_only_hpx_init PRIVATE ${test_SOURCE_DIR}
       )
-      target_include_directories(
-        hello_world_client_only_hpx_init PRIVATE HPX_DEBUG
-      )
 
       target_link_libraries(
         hello_world_client_only_hpx_init PRIVATE hello_world_component

hpx/runtime/components/server/component_base.hpp

@@ -77,14 +77,6 @@ namespace hpx { namespace components
             HPX_EXPORT naming::id_type get_unmanaged_id(
                 naming::gid_type const& gid) const;
 
-#if defined(HPX_DISABLE_ASSERTS) || defined(BOOST_DISABLE_ASSERTS) || defined(NDEBUG)
-            static constexpr void mark_as_migrated()
-            {
-            }
-            static constexpr void on_migrated()
-            {
-            }
-#else
             static void mark_as_migrated()
             {
                 // If this assertion is triggered then this component instance is
@@ -100,7 +92,6 @@ namespace hpx { namespace components
                 // migration.
                 HPX_ASSERT(false);
             }
-#endif
 
         protected:
             // Create a new GID (if called for the first time), assign this

hpx/runtime/components/server/fixed_component_base.hpp

@@ -156,14 +156,6 @@ class fixed_component_base : public traits::detail::fixed_component_tag
         }
     }
 
-#if defined(HPX_DISABLE_ASSERTS) || defined(BOOST_DISABLE_ASSERTS) || defined(NDEBUG)
-    static constexpr void mark_as_migrated()
-    {
-    }
-    static constexpr void on_migrated()
-    {
-    }
-#else
     void mark_as_migrated()
     {
         // If this assertion is triggered then this component instance is being
@@ -179,7 +171,6 @@ class fixed_component_base : public traits::detail::fixed_component_tag
         // migration.
         HPX_ASSERT(false);
     }
-#endif
 
 private:
     mutable naming::gid_type gid_;
@@ -192,15 +183,6 @@ namespace detail
     ///////////////////////////////////////////////////////////////////////
     struct fixed_heap
     {
-#if defined(HPX_DISABLE_ASSERTS) || defined(BOOST_DISABLE_ASSERTS) || defined(NDEBUG)
-        static constexpr void* alloc(std::size_t /*count*/)
-        {
-            return nullptr;
-        }
-        static constexpr void free(void* /*p*/, std::size_t /*count*/)
-        {
-        }
-#else
         static void* alloc(std::size_t /*count*/)
         {
             HPX_ASSERT(false);        // this shouldn't ever be called
@@ -210,7 +192,6 @@ namespace detail
         {
             HPX_ASSERT(false);        // this shouldn't ever be called
         }
-#endif
     };
 }
 
@@ -224,17 +205,6 @@ class fixed_component : public Component
     typedef component_type derived_type;
     typedef detail::fixed_heap heap_type;
 
-#if defined(HPX_DISABLE_ASSERTS) || defined(BOOST_DISABLE_ASSERTS) || defined(NDEBUG)
-    static constexpr Component* create(std::size_t /* count */)
-    {
-        return nullptr;
-    }
-
-    static constexpr void destroy(
-        Component* /* p */, std::size_t /* count */ = 1)
-    {
-    }
-#else
     /// \brief  The function \a create is used for allocation and
     ///         initialization of instances of the derived components.
     static Component* create(std::size_t /* count */)
@@ -249,9 +219,6 @@ class fixed_component : public Component
     {
         HPX_ASSERT(false);        // this shouldn't ever be called
     }
-#endif
 };
 
 }}
-
-

hpx/runtime/components/server/managed_component_base.hpp

@@ -171,14 +171,6 @@ namespace hpx { namespace components
             ///        destructed
             static constexpr void finalize() {}
 
-#if defined(HPX_DISABLE_ASSERTS) || defined(BOOST_DISABLE_ASSERTS) || defined(NDEBUG)
-            static constexpr void mark_as_migrated()
-            {
-            }
-            static constexpr void on_migrated()
-            {
-            }
-#else
             static void mark_as_migrated()
             {
                 // If this assertion is triggered then this component instance is
@@ -194,7 +186,6 @@ namespace hpx { namespace components
                 // migration.
                 HPX_ASSERT(false);
             }
-#endif
         };
     }
 

libs/core/config/include/hpx/config/debug.hpp

@@ -14,20 +14,9 @@
 #define HPX_BUILD_TYPE
 #else
 
-// clang-format off
-// Make sure DEBUG macro is defined consistently across platforms
-#if defined(_DEBUG) && !defined(DEBUG)
-#  define DEBUG
-#endif
-
-#if defined(DEBUG) && !defined(HPX_DEBUG)
-#  define HPX_DEBUG
-#endif
-
 #if defined(HPX_DEBUG)
-#  define HPX_BUILD_TYPE debug
+#define HPX_BUILD_TYPE debug
 #else
-#  define HPX_BUILD_TYPE release
+#define HPX_BUILD_TYPE release
 #endif
 #endif
-// clang-format on

libs/core/functional/include/hpx/functional/one_shot.hpp

@@ -25,10 +25,11 @@ namespace hpx { namespace util {
         class one_shot_wrapper    //-V690
         {
         public:
-#if !defined(HPX_DISABLE_ASSERTS)
             // default constructor is needed for serialization
             constexpr one_shot_wrapper()
+#if defined(HPX_DEBUG)
               : _called(false)
+#endif
             {
             }
 
@@ -37,42 +38,30 @@ namespace hpx { namespace util {
                     std::is_constructible<F, F_>::value>::type>
             constexpr explicit one_shot_wrapper(F_&& f)
               : _f(std::forward<F_>(f))
+#if defined(HPX_DEBUG)
               , _called(false)
+#endif
             {
             }
 
             constexpr one_shot_wrapper(one_shot_wrapper&& other)
               : _f(std::move(other._f))
+#if defined(HPX_DEBUG)
               , _called(other._called)
+#endif
             {
+#if defined(HPX_DEBUG)
                 other._called = true;
+#endif
             }
 
             void check_call()
             {
+#if defined(HPX_DEBUG)
                 HPX_ASSERT(!_called);
-
                 _called = true;
-            }
-#else
-            // default constructor is needed for serialization
-            constexpr one_shot_wrapper() {}
-
-            template <typename F_,
-                typename = typename std::enable_if<
-                    std::is_constructible<F, F_>::value>::type>
-            constexpr explicit one_shot_wrapper(F_&& f)
-              : _f(std::forward<F_>(f))
-            {
-            }
-
-            constexpr one_shot_wrapper(one_shot_wrapper&& other)
-              : _f(std::move(other._f))
-            {
-            }
-
-            void check_call() {}
 #endif
+            }
 
             template <typename... Ts>
             constexpr HPX_HOST_DEVICE
@@ -118,7 +107,7 @@ namespace hpx { namespace util {
 
         public:    // exposition-only
             F _f;
-#if !defined(HPX_DISABLE_ASSERTS)
+#if defined(HPX_DEBUG)
             bool _called;
 #endif
         };