Auto-generate resource spec file

trilinos · Apr 8, 2020 · 370f6f0 · 370f6f0
1 parent 2dc624e
commit 370f6f0
Show file tree

Hide file tree

Showing 3 changed files with 128 additions and 1 deletion.
diff --git a/cmake/tribits/core/package_arch/TribitsGenerateResourceSpecFile.cmake b/cmake/tribits/core/package_arch/TribitsGenerateResourceSpecFile.cmake
@@ -0,0 +1,74 @@
+# @HEADER
+# ************************************************************************
+#
+#            TriBITS: Tribal Build, Integrate, and Test System
+#                    Copyright 2013 Sandia Corporation
+#
+# Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
+# the U.S. Government retains certain rights in this software.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+# 1. Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+#
+# 3. Neither the name of the Corporation nor the names of the
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
+# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# ************************************************************************
+# @HEADER
+
+
+#
+# Generate resource spec file
+#
+
+
+FUNCTION(TRIBITS_GENERATE_RESOURCE_SPEC_FILE)
+  SET(GPUS_JSON)
+  MATH(EXPR LAST_GPU "${${PROJECT_NAME}_CUDA_NUM_GPUS} - 1")
+  SET(FIRST 1)
+  FOREACH(GPU RANGE 0 ${LAST_GPU})
+    IF(NOT FIRST)
+      STRING(APPEND GPUS_JSON ",\n")
+    ENDIF()
+    SET(FIRST 0)
+    STRING(APPEND GPUS_JSON "        {
+          \"id\": \"${GPU}\",
+          \"slots\": ${${PROJECT_NAME}_CUDA_SLOTS_PER_GPU}
+        }")
+  ENDFOREACH()
+  FILE(WRITE "${CMAKE_BINARY_DIR}/ctest_resources.json" "{
+  \"version\": {
+    \"major\": 1,
+    \"minor\": 0
+  },
+  \"local\": [
+    {
+      \"gpus\": [
+${GPUS_JSON}
+      ]
+    }
+  ]
+}
+")
+ENDFUNCTION()
diff --git a/cmake/tribits/core/package_arch/TribitsGlobalMacros.cmake b/cmake/tribits/core/package_arch/TribitsGlobalMacros.cmake
@@ -427,6 +427,38 @@ MACRO(TRIBITS_DEFINE_GLOBAL_OPTIONS_AND_DEFINE_EXTRA_REPOS)
     "Enable explicit template instantiation in all packages that support it"
     )
 
+  ADVANCED_SET(${PROJECT_NAME}_AUTOGENERATE_TEST_RESOURCE_FILE OFF
+    CACHE BOOL
+    "Auto-generate a resource spec file for use with CTest."
+    )
+
+  ADVANCED_SET(${PROJECT_NAME}_CUDA_NUM_GPUS 1
+    CACHE STRING
+    "Number of GPUS to make available in the auto-generated resource spec file."
+    )
+
+  ADVANCED_SET(${PROJECT_NAME}_CUDA_SLOTS_PER_GPU 1
+    CACHE STRING
+    "Number of slots per GPU in the auto-generated resource spec file."
+    )
+
+  SET(CTEST_RESOURCE_SPEC_FILE_DOC_EXTRA "")
+  IF (${PROJECT_NAME}_AUTOGENERATE_TEST_RESOURCE_FILE)
+    SET(CTEST_RESOURCE_SPEC_FILE_DEFAULT  ${CMAKE_BINARY_DIR}/ctest_resources.json)
+    IF ("${CTEST_RESOURCE_SPEC_FILE}" STREQUAL "")
+      SET(CTEST_RESOURCE_SPEC_FILE_DOC_EXTRA
+         "  This file is autogenerated by default since ${PROJECT_NAME}_AUTOGENERATE_TEST_RESOURCE_FILE=${${PROJECT_NAME}_AUTOGENERATE_TEST_RESOURCE_FILE}!" )
+    ENDIF()
+  ELSE()
+    SET(CTEST_RESOURCE_SPEC_FILE_DEFAULT "")
+  ENDIF()
+
+  ADVANCED_SET(CTEST_RESOURCE_SPEC_FILE
+    "${CTEST_RESOURCE_SPEC_FILE_DEFAULT}"
+    CACHE FILEPATH
+    "Resource spec file for CTest.${CTEST_RESOURCE_SPEC_FILE_DOC_EXTRA}"
+    )
+
   IF (USE_XSDK_DEFAULTS)
     # Need to set BUILD_SHARED_LIBS default here based on USE_XSDK_DEFAULTS
     # and not in TRIBITS_SETUP_ENV() in case there is logic in TriBITS or

diff --git a/cmake/tribits/core/package_arch/TribitsProjectImpl.cmake b/cmake/tribits/core/package_arch/TribitsProjectImpl.cmake
@@ -66,6 +66,7 @@ INCLUDE(TribitsIncludeDirectories)
 INCLUDE(TribitsFindPythonInterp)
 INCLUDE(TribitsGlobalMacros)
 INCLUDE(TribitsConfigureCTestCustom)
+INCLUDE(TribitsGenerateResourceSpecFile)
 
 INCLUDE(AdvancedSet)
 INCLUDE(AdvancedOption)
@@ -321,7 +322,27 @@ MACRO(TRIBITS_PROJECT_IMPL)
   ENDIF()
 
   #
-  # N) Show final timing and end
+  # N) Generate resource spec file if applicable
+  #
+
+  IF (${PROJECT_NAME}_AUTOGENERATE_TEST_RESOURCE_FILE)
+    IF (CTEST_RESOURCE_SPEC_FILE STREQUAL CTEST_RESOURCE_SPEC_FILE_DEFAULT)
+      TRIBITS_GENERATE_RESOURCE_SPEC_FILE()
+    ELSE()
+      MESSAGE("NOTE: The test resource file CTEST_RESOURCE_SPEC_FILE='${CTEST_RESOURCE_SPEC_FILE}'"
+        " will not be auto-generated even through"
+        " ${PROJECT_NAME}_AUTOGENERATE_TEST_RESOURCE_FILE=${${PROJECT_NAME}_AUTOGENERATE_TEST_RESOURCE_FILE}"
+        " because its location does not match the default"
+        " location '${CTEST_RESOURCE_SPEC_FILE_DEFAULT}'."
+        "  If you want to auto-generate this file, please clear CTEST_RESOURCE_SPEC_FILE and"
+        " reconfigure or create that file on your own and clear"
+        " ${PROJECT_NAME}_AUTOGENERATE_TEST_RESOURCE_FILE."
+        )
+    ENDIF()
+  ENDIF()
+
+  #
+  # O) Show final timing and end
   #
 
   MESSAGE("")