Merge pull request #544 from ValeevGroup/evaleev/build/werror

build: enable -Werror on TA translation units (opt-in via TA_WERROR)

Author: evaleev

.github/workflows/ci.yml

@@ -39,6 +39,7 @@ jobs:
         -DCMAKE_PREFIX_PATH="/usr/local/opt/bison;/usr/local/opt/scalapack;/usr/local/opt/boost"
         -DTA_ASSERT_POLICY=TA_ASSERT_THROW
         -DTA_SCALAPACK=ON
+        -DTA_WERROR=ON
 
     steps:
     - uses: actions/checkout@v4

.gitlab-ci.yml

@@ -12,6 +12,7 @@ variables:
   TA_CONFIG : >
     CMAKE_BUILD_TYPE=${BUILD_TYPE}
     TA_ASSERT_POLICY=TA_ASSERT_THROW
+    TA_WERROR=ON
     TA_UT_CTEST_TIMEOUT=3000
     ${TA_PYTHON}
     ${TA_CUDA}

CMakeLists.txt

@@ -149,6 +149,10 @@ add_feature_info(TENSOR_ASSERT_NO_MUTABLE_OPS_WHILE_SHARED TA_TENSOR_ASSERT_NO_M
 
 option(TA_EXPERT "TiledArray Expert mode: disables automatically downloading or building dependencies" OFF)
 
+redefaultable_option(TA_WERROR "Treat compiler warnings as errors when compiling TiledArray's own translation units (does not propagate to consumers of installed TiledArray targets)" OFF)
+add_feature_info(WERROR TA_WERROR "Treat compiler warnings as errors on TiledArray's own translation units")
+include(TiledArrayWarnings)
+
 option(TA_SIGNED_1INDEX_TYPE "Enables the use of signed 1-index coordinate type (OFF in 1.0.0-alpha.2 and older)" ON)
 add_feature_info(SIGNED_1INDEX_TYPE TA_SIGNED_1INDEX_TYPE "Use of signed 1-index coordinate type in TiledArray")
 

INSTALL.md

@@ -428,6 +428,7 @@ support may be added.
 * `BUILD_TESTING` -- Set of `OFF` to disable building unit tests. The default is `ON`.
 * `TA_TRACE_TASKS` -- Set to `ON` to enable tracing of MADNESS tasks using custom task tracer. Note that standard profilers/tracers are generally useless (except in the trivial cases) with MADWorld-based programs since the submission context of tasks is not captured by standard tracing tools; this makes it impossible in a nontrivial program to attribute tasks to source code. WARNING: task tracing his will greatly increase the memory requirements. [Default=OFF].
 * `TA_TTG` -- Set to `ON` to find or fetch the TTG library. [Default=OFF].
+* `TA_WERROR` -- Set to `ON` to treat compiler warnings as errors when compiling TiledArray's own translation units (the `tiledarray` library and in-tree tests/examples). Also implies `MADNESS_WERROR=ON` for the MADworld translation units built as part of TA's FetchContent tree. Does **not** propagate to consumers of the installed `tiledarray` target (i.e. `find_package(tiledarray)` users do not inherit `-Werror`). Honored on GNU/Clang/AppleClang/IntelLLVM. [Default=OFF].
 * `TA_SIGNED_1INDEX_TYPE` -- Set to `OFF` to use unsigned 1-index coordinate type (default for TiledArray 1.0.0-alpha.2 and older). The default is `ON`, which enables the use of negative indices in coordinates.
 * `TA_MAX_SOO_RANK_METADATA` -- Specifies the maximum rank for which to use Small Object Optimization (hence, avoid the use of the heap) for metadata. The default is `8`.
 * `TA_TENSOR_MEM_PROFILE` -- Set to `ON` to profile host memory allocations used by TA::Tensor. This causes the use of Umpire for host memory allocation. This also enables additional tracing facilities provided by Umpire; these can be controlled via [environment variable `UMPIRE_LOG_LEVEL`](https://umpire.readthedocs.io/en/develop/sphinx/features/logging_and_replay.html), but note that the default is to log Umpire info into a file rather than stdout.

cmake/modules/AddTAExecutable.cmake

@@ -2,5 +2,6 @@ macro(add_ta_executable _name _source_files _libs)
 
   add_executable(${_name} EXCLUDE_FROM_ALL "${_source_files}")
   target_link_libraries(${_name} PRIVATE "${_libs}")
+  target_link_libraries(${_name} PRIVATE tiledarray_internal_warnings)
 
 endmacro()

cmake/modules/FindOrFetchBTAS.cmake

@@ -75,3 +75,20 @@ endif(NOT TARGET BTAS::BTAS)
 if (NOT TARGET BTAS::BTAS)
   message(FATAL_ERROR "FindOrFetchBTAS could not make BTAS::BTAS target available")
 endif(NOT TARGET BTAS::BTAS)
+
+# Treat BTAS headers as system: header-only library, no include-order
+# risk against TA's headers, and BTAS upstream trips warnings TA itself
+# can't fix (e.g. btas/generic/converge_class.h -Wreturn-type on gcc).
+# Carved out specifically here despite the top-level
+# CMAKE_NO_SYSTEM_FROM_IMPORTED=TRUE.
+get_target_property(_btas_aliased BTAS::BTAS ALIASED_TARGET)
+if (NOT _btas_aliased)
+  set(_btas_aliased BTAS::BTAS)
+endif()
+get_target_property(_btas_inc ${_btas_aliased} INTERFACE_INCLUDE_DIRECTORIES)
+if (_btas_inc)
+  set_target_properties(${_btas_aliased} PROPERTIES
+      INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "${_btas_inc}")
+endif()
+unset(_btas_inc)
+unset(_btas_aliased)

cmake/modules/FindOrFetchMADWorld.cmake

@@ -22,6 +22,13 @@ if (NOT TARGET MADworld)
     endif()
   endif()
   set(MPI_THREAD "multiple" CACHE INTERNAL "MADNESS requires MPI_THREAD_MULTIPLE")
+  # TA_WERROR=ON implies MADNESS_WERROR=ON: warnings-as-errors should cover
+  # the MADNESS translation units built as part of TA's FetchContent tree.
+  # (Requires a MADNESS pin that includes the MADNESS_WERROR option; otherwise
+  #  this cache variable is harmlessly ignored.)
+  if (TA_WERROR)
+    set(MADNESS_WERROR ON CACHE BOOL "Treat compiler warnings as errors when compiling MADNESS's own translation units" FORCE)
+  endif()
   set(MADNESS_ASSUMES_ASLR_DISABLED ${TA_ASSUMES_ASLR_DISABLED} CACHE BOOL "Whether MADNESS assumes ASLR to be disabled")
   set(MPI_CXX_SKIP_MPICXX ON CACHE BOOL "Whether to disable search for C++ MPI-2 bindings")
   set(DISABLE_WORLD_GET_DEFAULT ON CACHE INTERNAL "Whether to disable madness::World::get_default()")

cmake/modules/FindOrFetchRangeV3.cmake

@@ -31,3 +31,23 @@ endif(NOT TARGET range-v3::range-v3)
 if (NOT TARGET range-v3::range-v3)
   message(FATAL_ERROR "FindOrFetchRangeV3 could not make range-v3::range-v3 target available")
 endif(NOT TARGET range-v3::range-v3)
+
+# Treat range-v3 headers as system: range-v3 is header-only with no
+# ordering risk against TA's headers, and it self-triggers
+# -Wdeprecated-declarations (e.g. ranges::compressed_tuple used inside
+# compressed_pair.hpp). The blanket CMAKE_NO_SYSTEM_FROM_IMPORTED=TRUE
+# at the top-level avoids -isystem for general imported targets due to
+# include-dir ordering; carve out range-v3 specifically here.
+# range-v3::range-v3 is an ALIAS — resolve to the underlying target before
+# touching properties.
+get_target_property(_rv3_aliased range-v3::range-v3 ALIASED_TARGET)
+if (NOT _rv3_aliased)
+  set(_rv3_aliased range-v3::range-v3)
+endif()
+get_target_property(_rv3_inc ${_rv3_aliased} INTERFACE_INCLUDE_DIRECTORIES)
+if (_rv3_inc)
+  set_target_properties(${_rv3_aliased} PROPERTIES
+      INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "${_rv3_inc}")
+endif()
+unset(_rv3_inc)
+unset(_rv3_aliased)

cmake/modules/TiledArrayWarnings.cmake

@@ -0,0 +1,53 @@
+include_guard(GLOBAL)
+
+# TiledArray internal warning-policy target.
+#
+# Owns an INTERFACE library `tiledarray_internal_warnings` that carries
+# the warning flags applied to TiledArray's own translation units. The
+# target is linked PRIVATE-ly to the `tiledarray` library and to
+# in-tree executables (via add_ta_executable). PRIVATE scope is
+# load-bearing: it keeps these flags out of INTERFACE_COMPILE_OPTIONS
+# on the installed/exported `tiledarray` target, so downstream
+# consumers (MPQC, ...) do not inherit -Werror through
+# find_package(tiledarray).
+#
+# The target is also NOT installed/exported, which keeps it out of the
+# package.
+
+add_library(tiledarray_internal_warnings INTERFACE)
+
+if (TA_WERROR)
+  if (CMAKE_CXX_COMPILER_ID MATCHES "^(GNU|Clang|AppleClang|IntelLLVM)$")
+    target_compile_options(tiledarray_internal_warnings INTERFACE
+      $<$<OR:$<COMPILE_LANGUAGE:CXX>,$<COMPILE_LANGUAGE:C>,$<COMPILE_LANGUAGE:HIP>>:-Werror>
+      # NVCC: forward -Werror to the host compiler, not to nvcc itself
+      # (nvcc's own -Werror is a different switch with a different surface).
+      $<$<COMPILE_LANGUAGE:CUDA>:-Xcompiler=-Werror>)
+    # gcc's interprocedural-after-inlining warnings have a long history of
+    # false positives — particularly across template-heavy inlining and
+    # idiomatic throw-on-assert patterns — that are repeatedly traded
+    # across releases (gcc-12/13/14/15 all have outstanding upstream
+    # bugzilla PRs in this family). Demote the noisiest of them to plain
+    # warnings on gcc so they still surface in build logs but do not
+    # gate CI. Clang does not exhibit these and stays under -Werror.
+    if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+      set(_ta_gcc_ipa_warnings
+          -Wno-error=nonnull
+          -Wno-error=stringop-overflow
+          -Wno-error=stringop-overread
+          -Wno-error=array-bounds
+          -Wno-error=dangling-pointer
+          -Wno-error=use-after-free
+          -Wno-error=restrict
+          -Wno-error=maybe-uninitialized)
+      foreach(_flag IN LISTS _ta_gcc_ipa_warnings)
+        target_compile_options(tiledarray_internal_warnings INTERFACE
+          $<$<OR:$<COMPILE_LANGUAGE:CXX>,$<COMPILE_LANGUAGE:C>>:${_flag}>
+          $<$<COMPILE_LANGUAGE:CUDA>:-Xcompiler=${_flag}>)
+      endforeach()
+      unset(_ta_gcc_ipa_warnings)
+    endif()
+  else()
+    message(WARNING "TA_WERROR=ON but compiler '${CMAKE_CXX_COMPILER_ID}' is not in the supported set; ignoring.")
+  endif()
+endif()

examples/scalapack/CMakeLists.txt

@@ -31,6 +31,7 @@ foreach(_exec conversion evp)
   # Add executable
   add_executable(scalapack-${_exec} EXCLUDE_FROM_ALL ${_exec}.cpp)
   target_link_libraries(scalapack-${_exec} PRIVATE tiledarray)
+  target_link_libraries(scalapack-${_exec} PRIVATE tiledarray_internal_warnings)
   add_dependencies(examples-tiledarray scalapack-${_exec})
 
 endforeach()