Merge pull request #2234 from DARMA-tasking/2233-release-vt-v140

#2233: Release vt v1.4.0

.env

@@ -3,7 +3,12 @@ ARCH=amd64
 UBUNTU=22.04
 ULIMIT_CORE=0
 COMPILER=gcc-12
+HOST_COMPILER=gcc-12
 COMPILER_TYPE=gnu
 PROXY=
-CACHE=
 TOKEN=
+DISTINCT_DIR="${ARCH}-${UBUNTU}-${HOST_COMPILER}-${COMPILER}-cache"
+
+# Change this path to save the volume content on disk.
+# Example: /your/path/${DISTINCT_DIR}/
+BUILD_ROOT=

.github/workflows/build-docs.yml

@@ -17,6 +17,7 @@ jobs:
       UBUNTU: 18.04
       COMPILER_TYPE: gnu
       COMPILER: gcc-8
+      HOST_COMPILER: gcc-8
       BUILD_TYPE: release
       ULIMIT_CORE: 0
       VT_LB: 1

.github/workflows/comment-on-pr.yml

@@ -4,7 +4,7 @@ on:
   repository_dispatch:
     types: comment-pr
 
-concurrency: ${{ github.event.repository.name }}-${{ github.ref }}
+concurrency: ${{ github.event.repository.name }}-${{ github.event.client_payload.pr_number }}
 
 jobs:
   comment-on-pr:

CMakeLists.txt

@@ -25,14 +25,16 @@ set(
   "${CMAKE_CURRENT_SOURCE_DIR}/cmake/"
 )
 
-# Try to find ccache to speed up compilation
-find_program(ccache_binary ccache)
-if (ccache_binary)
-  message(
-    STATUS
-    "VT: Found ccache binary: ${ccache_binary}; adding launch rule"
-  )
-  set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE "${ccache_binary}")
+if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR AND NOT DEFINED CMAKE_CXX_COMPILER_LAUNCHER)
+  # Try to find ccache to speed up compilation
+  find_program(ccache_binary ccache)
+  if (ccache_binary)
+    message(
+      STATUS
+      "VT: Found ccache binary: ${ccache_binary}; adding launch rule"
+    )
+    set(CMAKE_CXX_COMPILER_LAUNCHER ${ccache_binary})
+  endif()
 endif()
 
 set(CMAKE_CXX_EXTENSIONS OFF)
@@ -43,8 +45,6 @@ if(NOT CMAKE_CXX_STANDARD)
 endif()
 message(STATUS "CMAKE_CXX_STANDARD: ${CMAKE_CXX_STANDARD}")
 
-option(CODE_COVERAGE "Enable coverage reporting" OFF)
-
 set(MPI_EXTRA_FLAGS "" CACHE STRING "Flags to pass to mpirun/mpiexec")
 string(REPLACE " " ";" MPI_EXTRA_FLAGS_LIST "${MPI_EXTRA_FLAGS}")
 message(STATUS "Running tests and examples with additional MPI flags = ${MPI_EXTRA_FLAGS_LIST}")
@@ -54,57 +54,32 @@ set(PROJECT_BIN_DIR     ${CMAKE_CURRENT_BINARY_DIR})
 set(PROJECT_BASE_DIR    ${CMAKE_CURRENT_SOURCE_DIR})
 set(PROJECT_LIB_DIR     ${CMAKE_CURRENT_SOURCE_DIR}/lib)
 set(PROJECT_EXAMPLE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/examples)
+set(PROJECT_TOOLS_DIR   ${CMAKE_CURRENT_SOURCE_DIR}/tools)
 
 # Import the linking macros for VT-related targets
 include(cmake/link_vt.cmake)
 
 # Load packages that are required for core VT build
 include(cmake/load_packages.cmake)
 
-include(cmake/check_compiler.cmake)
-
-option(vt_gold_linker_enabled "Build VT using the `gold' linker" ON)
-
-option(vt_unity_build_enabled "Build VT with Unity/Jumbo mode enabled" OFF)
-
-if (vt_unity_build_enabled)
-    message(STATUS "Building VT in Unity/Jumbo build mode")
-endif()
-
-# Option included here, handled in define_build_modes.cmake so libfort can be
-# included correspondingly
-option(vt_diagnostics_enabled "Build VT with performance metrics/stats" ON)
-
-if (vt_diagnostics_enabled)
-  # Default libfort ON if diagnostics are enabled
-  option(vt_libfort_enabled "Build VT with fort library enabled" ON)
-else()
-  option(vt_libfort_enabled "Build VT with fort library enabled" OFF)
-endif()
-
-option(vt_mimalloc_enabled "Build VT with mimalloc" OFF)
-option(vt_mimalloc_static "Build VT with mimalloc using static linking" ON)
-option(vt_asan_enabled "Build VT with address sanitizer" OFF)
-option(vt_ubsan_enabled "Build VT with undefined behavior sanitizer" OFF)
-option(vt_werror_enabled "Build VT with -Werror enabled" OFF)
+# Some options use TPL information (whether Perl was found etc.)
+include(cmake/configure_options.cmake)
 
+include(cmake/check_compiler.cmake)
 include(cmake/nvcc_no_deprecated_gpu_targets.cmake)
 include(cmake/load_bundled_libraries.cmake)
 
-option(vt_trace_only "Build VT with trace-only mode enabled" OFF)
-if (vt_trace_only)
-  message(STATUS "Building additional target for VT in trace-only mode")
-endif()
 
 # Primary VT build
 add_subdirectory(src)
 
+if(vt_no_color_enabled)
+  target_compile_definitions(${VIRTUAL_TRANSPORT_LIBRARY} PUBLIC VT_NO_COLOR_ENABLED)
+endif()
 #
 # Test prep - ensures examples can be registered as tests.
 #
-option(VT_BUILD_TESTS "Build VT tests" ON)
-
-if (VT_BUILD_TESTS
+if (vt_build_tests
    AND "${CMAKE_PROJECT_NAME}" STREQUAL "${PROJECT_NAME}")
   # CTest implies enable_testing() and defines the BUILD_TESTING option.
   # The default of BUILD_TESTING is ON.
@@ -113,11 +88,26 @@ if (VT_BUILD_TESTS
 endif()
 
 #
-# Examples
+# Tools
 #
-option(VT_BUILD_EXAMPLES "Build VT examples" ON)
+if (vt_build_tools)
+  message(
+    STATUS
+    "VT: building tools"
+  )
 
-if (VT_BUILD_EXAMPLES)
+  add_custom_target(tools)
+  add_subdirectory(tools)
+else()
+  message(
+    STATUS "VT: NOT building tools because vt_build_tools is not set."
+  )
+endif()
+
+#
+# Examples
+#
+if (vt_build_examples)
   message(
     STATUS
     "VT: building examples"
@@ -127,7 +117,7 @@ if (VT_BUILD_EXAMPLES)
   add_subdirectory(examples)
 else()
   message(
-    STATUS "VT: NOT building examples because VT_BUILD_EXAMPLES is not set.\
+    STATUS "VT: NOT building examples because vt_build_examples is not set.\
  Examples that are not built are NOT TESTED."
   )
 endif()
@@ -137,7 +127,7 @@ endif()
 #
 
 if (BUILD_TESTING
-   AND VT_BUILD_TESTS
+   AND vt_build_tests
    AND CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
   message(
     STATUS
@@ -150,7 +140,7 @@ if (BUILD_TESTING
 else()
   message(
     STATUS
-    "VT: NOT building tests because VT_BUILD_TESTS or BUILD_TESTING are not set"
+    "VT: NOT building tests because vt_build_tests or BUILD_TESTING are not set"
   )
 endif()
 

ci/azure/azure-clang-10-ubuntu-mpich.yml

@@ -28,9 +28,10 @@ variables:
   UBUNTU: 20.04
   COMPILER_TYPE: clang
   COMPILER: clang-10
+  HOST_COMPILER: clang-10
   BUILD_TYPE: release
   ULIMIT_CORE: 0
-  CODE_COVERAGE: 0
+  VT_CODE_COVERAGE: 0
   VT_LB: 1
   VT_TRACE: 0
   VT_TRACE_RT: 0
@@ -56,7 +57,8 @@ variables:
   TEST_LB_SCHEMA: 0
   CACHE: "$(Agent.TempDirectory)/cache/"
   cache_name: ubuntu-clang-10-cache
-  build_root: "$(CACHE)/$(ARCH)-ubuntu-$(UBUNTU)-$(COMPILER)-cache/"
+  volume_name: ubuntu-cpp
+  build_root: "$(CACHE)$(ARCH)-ubuntu-$(UBUNTU)-$(HOST_COMPILER)-$(COMPILER)-cache/"
   TS: 0
   TS_YEAR: 0
   TS_MONTH: 0
@@ -112,7 +114,7 @@ stages:
         inputs:
           securityNamespace: cache
           key: $(Agent.OS) | "$(cache_name)" | $(TS_YEAR) | $(TS_MONTH) | $(TS_DAY) | $(TS)
-          path: '$(build_root)/ccache'
+          path: '$(build_root)$(volume_name)/ccache'
           restoreKeys: |
             $(Agent.OS) | "$(cache_name)" | $(TS_YEAR) | $(TS_MONTH) | $(TS_DAY)
             $(Agent.OS) | "$(cache_name)" | $(TS_YEAR) | $(TS_MONTH)
@@ -150,8 +152,8 @@ stages:
           targetType: 'inline'
           script: |
             ./scripts/report_logs_in_comment.sh                     \
-                "$(build_root)/vt/compilation_errors_warnings.out"  \
-                "$(build_root)/vt/cmake-output.log"                 \
+                "$(build_root)$(volume_name)/vt/compilation_errors_warnings.out"  \
+                "$(build_root)$(volume_name)/vt/cmake-output.log"                 \
                 "$(Build.BuildNumber)"                              \
                 "$(System.PullRequest.PullRequestNumber)"           \
                 "$(Build.Repository.Name)"                          \
@@ -178,8 +180,8 @@ stages:
         inputs:
           targetType: 'inline'
           script: |
-            zip -j $(Agent.TempDirectory)/LastTest.log.gz $(build_root)/vt/Testing/Temporary/LastTest.log
-            zip -j $(Agent.TempDirectory)/cmake-output.log.gz $(build_root)/vt/cmake-output.log
+            zip -j $(Agent.TempDirectory)/LastTest.log.gz $(build_root)$(volume_name)/vt/Testing/Temporary/LastTest.log
+            zip -j $(Agent.TempDirectory)/cmake-output.log.gz $(build_root)$(volume_name)/vt/cmake-output.log
       - task: PublishPipelineArtifact@1
         displayName: Upload CMake test output artifact
         continueOnError: true

ci/azure/azure-clang-11-ubuntu-mpich.yml

@@ -28,9 +28,10 @@ variables:
   UBUNTU: 22.04
   COMPILER_TYPE: clang
   COMPILER: clang-11
+  HOST_COMPILER: clang-11
   BUILD_TYPE: release
   ULIMIT_CORE: 0
-  CODE_COVERAGE: 0
+  VT_CODE_COVERAGE: 0
   VT_LB: 1
   VT_TRACE: 0
   VT_TRACE_RT: 0
@@ -56,7 +57,8 @@ variables:
   TEST_LB_SCHEMA: 0
   CACHE: "$(Agent.TempDirectory)/cache/"
   cache_name: ubuntu-clang-11-cache
-  build_root: "$(CACHE)/$(ARCH)-ubuntu-$(UBUNTU)-$(COMPILER)-cache/"
+  volume_name: ubuntu-cpp
+  build_root: "$(CACHE)$(ARCH)-ubuntu-$(UBUNTU)-$(HOST_COMPILER)-$(COMPILER)-cache/"
   TS: 0
   TS_YEAR: 0
   TS_MONTH: 0
@@ -112,7 +114,7 @@ stages:
         inputs:
           securityNamespace: cache
           key: $(Agent.OS) | "$(cache_name)" | $(TS_YEAR) | $(TS_MONTH) | $(TS_DAY) | $(TS)
-          path: '$(build_root)/ccache'
+          path: '$(build_root)$(volume_name)/ccache'
           restoreKeys: |
             $(Agent.OS) | "$(cache_name)" | $(TS_YEAR) | $(TS_MONTH) | $(TS_DAY)
             $(Agent.OS) | "$(cache_name)" | $(TS_YEAR) | $(TS_MONTH)
@@ -150,8 +152,8 @@ stages:
           targetType: 'inline'
           script: |
             ./scripts/report_logs_in_comment.sh                     \
-                "$(build_root)/vt/compilation_errors_warnings.out"  \
-                "$(build_root)/vt/cmake-output.log"                 \
+                "$(build_root)$(volume_name)/vt/compilation_errors_warnings.out"  \
+                "$(build_root)$(volume_name)/vt/cmake-output.log"                 \
                 "$(Build.BuildNumber)"                              \
                 "$(System.PullRequest.PullRequestNumber)"           \
                 "$(Build.Repository.Name)"                          \
@@ -178,8 +180,8 @@ stages:
         inputs:
           targetType: 'inline'
           script: |
-            zip -j $(Agent.TempDirectory)/LastTest.log.gz $(build_root)/vt/Testing/Temporary/LastTest.log
-            zip -j $(Agent.TempDirectory)/cmake-output.log.gz $(build_root)/vt/cmake-output.log
+            zip -j $(Agent.TempDirectory)/LastTest.log.gz $(build_root)$(volume_name)/vt/Testing/Temporary/LastTest.log
+            zip -j $(Agent.TempDirectory)/cmake-output.log.gz $(build_root)$(volume_name)/vt/cmake-output.log
       - task: PublishPipelineArtifact@1
         displayName: Upload CMake test output artifact
         continueOnError: true

ci/azure/azure-clang-12-ubuntu-mpich.yml

@@ -28,9 +28,10 @@ variables:
   UBUNTU: 22.04
   COMPILER_TYPE: clang
   COMPILER: clang-12
+  HOST_COMPILER: clang-12
   BUILD_TYPE: release
   ULIMIT_CORE: 0
-  CODE_COVERAGE: 0
+  VT_CODE_COVERAGE: 0
   VT_LB: 1
   VT_TRACE: 0
   VT_TRACE_RT: 0
@@ -56,7 +57,8 @@ variables:
   TEST_LB_SCHEMA: 0
   CACHE: "$(Agent.TempDirectory)/cache/"
   cache_name: ubuntu-clang-12-cache
-  build_root: "$(CACHE)/$(ARCH)-ubuntu-$(UBUNTU)-$(COMPILER)-cache/"
+  volume_name: ubuntu-cpp
+  build_root: "$(CACHE)$(ARCH)-ubuntu-$(UBUNTU)-$(HOST_COMPILER)-$(COMPILER)-cache/"
   TS: 0
   TS_YEAR: 0
   TS_MONTH: 0
@@ -112,7 +114,7 @@ stages:
         inputs:
           securityNamespace: cache
           key: $(Agent.OS) | "$(cache_name)" | $(TS_YEAR) | $(TS_MONTH) | $(TS_DAY) | $(TS)
-          path: '$(build_root)/ccache'
+          path: '$(build_root)$(volume_name)/ccache'
           restoreKeys: |
             $(Agent.OS) | "$(cache_name)" | $(TS_YEAR) | $(TS_MONTH) | $(TS_DAY)
             $(Agent.OS) | "$(cache_name)" | $(TS_YEAR) | $(TS_MONTH)
@@ -150,8 +152,8 @@ stages:
           targetType: 'inline'
           script: |
             ./scripts/report_logs_in_comment.sh                     \
-                "$(build_root)/vt/compilation_errors_warnings.out"  \
-                "$(build_root)/vt/cmake-output.log"                 \
+                "$(build_root)$(volume_name)/vt/compilation_errors_warnings.out"  \
+                "$(build_root)$(volume_name)/vt/cmake-output.log"                 \
                 "$(Build.BuildNumber)"                              \
                 "$(System.PullRequest.PullRequestNumber)"           \
                 "$(Build.Repository.Name)"                          \
@@ -178,8 +180,8 @@ stages:
         inputs:
           targetType: 'inline'
           script: |
-            zip -j $(Agent.TempDirectory)/LastTest.log.gz $(build_root)/vt/Testing/Temporary/LastTest.log
-            zip -j $(Agent.TempDirectory)/cmake-output.log.gz $(build_root)/vt/cmake-output.log
+            zip -j $(Agent.TempDirectory)/LastTest.log.gz $(build_root)$(volume_name)/vt/Testing/Temporary/LastTest.log
+            zip -j $(Agent.TempDirectory)/cmake-output.log.gz $(build_root)$(volume_name)/vt/cmake-output.log
       - task: PublishPipelineArtifact@1
         displayName: Upload CMake test output artifact
         continueOnError: true

ci/azure/azure-clang-13-ubuntu-mpich.yml

@@ -28,9 +28,10 @@ variables:
   UBUNTU: 22.04
   COMPILER_TYPE: clang
   COMPILER: clang-13
+  HOST_COMPILER: clang-13
   BUILD_TYPE: release
   ULIMIT_CORE: 0
-  CODE_COVERAGE: 0
+  VT_CODE_COVERAGE: 0
   VT_LB: 1
   VT_TRACE: 0
   VT_TRACE_RT: 0
@@ -56,7 +57,8 @@ variables:
   TEST_LB_SCHEMA: 0
   CACHE: "$(Agent.TempDirectory)/cache/"
   cache_name: ubuntu-clang-13-cache
-  build_root: "$(CACHE)/$(ARCH)-ubuntu-$(UBUNTU)-$(COMPILER)-cache/"
+  volume_name: ubuntu-cpp
+  build_root: "$(CACHE)$(ARCH)-ubuntu-$(UBUNTU)-$(HOST_COMPILER)-$(COMPILER)-cache/"
   TS: 0
   TS_YEAR: 0
   TS_MONTH: 0
@@ -112,7 +114,7 @@ stages:
         inputs:
           securityNamespace: cache
           key: $(Agent.OS) | "$(cache_name)" | $(TS_YEAR) | $(TS_MONTH) | $(TS_DAY) | $(TS)
-          path: '$(build_root)/ccache'
+          path: '$(build_root)$(volume_name)/ccache'
           restoreKeys: |
             $(Agent.OS) | "$(cache_name)" | $(TS_YEAR) | $(TS_MONTH) | $(TS_DAY)
             $(Agent.OS) | "$(cache_name)" | $(TS_YEAR) | $(TS_MONTH)
@@ -150,8 +152,8 @@ stages:
           targetType: 'inline'
           script: |
             ./scripts/report_logs_in_comment.sh                     \
-                "$(build_root)/vt/compilation_errors_warnings.out"  \
-                "$(build_root)/vt/cmake-output.log"                 \
+                "$(build_root)$(volume_name)/vt/compilation_errors_warnings.out"  \
+                "$(build_root)$(volume_name)/vt/cmake-output.log"                 \
                 "$(Build.BuildNumber)"                              \
                 "$(System.PullRequest.PullRequestNumber)"           \
                 "$(Build.Repository.Name)"                          \
@@ -178,8 +180,8 @@ stages:
         inputs:
           targetType: 'inline'
           script: |
-            zip -j $(Agent.TempDirectory)/LastTest.log.gz $(build_root)/vt/Testing/Temporary/LastTest.log
-            zip -j $(Agent.TempDirectory)/cmake-output.log.gz $(build_root)/vt/cmake-output.log
+            zip -j $(Agent.TempDirectory)/LastTest.log.gz $(build_root)$(volume_name)/vt/Testing/Temporary/LastTest.log
+            zip -j $(Agent.TempDirectory)/cmake-output.log.gz $(build_root)$(volume_name)/vt/cmake-output.log
       - task: PublishPipelineArtifact@1
         displayName: Upload CMake test output artifact
         continueOnError: true