Tone down note about not pinning threads
[gromacs.git] / cmake / gmxCTestUtilities.cmake
blobed2736cdf4c6994b17b933796c0f57fe94c5b175
2 # This file is part of the GROMACS molecular simulation package.
4 # Copyright (c) 2016,2017, by the GROMACS development team, led by
5 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6 # and including many others, as listed in the AUTHORS file in the
7 # top-level source directory and at http://www.gromacs.org.
9 # GROMACS is free software; you can redistribute it and/or
10 # modify it under the terms of the GNU Lesser General Public License
11 # as published by the Free Software Foundation; either version 2.1
12 # of the License, or (at your option) any later version.
14 # GROMACS is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 # Lesser General Public License for more details.
19 # You should have received a copy of the GNU Lesser General Public
20 # License along with GROMACS; if not, see
21 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
22 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
24 # If you want to redistribute modifications to GROMACS, please
25 # consider that scientific software is very special. Version
26 # control is crucial - bugs must be traceable. We will be happy to
27 # consider code for inclusion in the official distribution, but
28 # derived work must not be called official GROMACS. Details are found
29 # in the README & COPYING files - if they are missing, get the
30 # official version at http://www.gromacs.org.
32 # To help us fund GROMACS development, we humbly ask that you cite
33 # the research papers on the package. Check out http://www.gromacs.org.
35 # Helper macros to encapsulate some usage of CTest
37 # This file is intended to contain CTest workarounds and such.
38 include(CMakeParseArguments)
40 macro (gmx_ctest_init)
41     # Set a default valgrind suppression file.
42     # This unfortunately needs to duplicate information from CTest to work as
43     # expected...
44     #set(MEMORYCHECK_SUPPRESSIONS_FILE
45     #    "${CMAKE_SOURCE_DIR}/cmake/legacy_and_external.supp"
46     #    CACHE FILEPATH
47     #    "File that contains suppressions for the memory checker")
48     string(TOUPPER "${CMAKE_BUILD_TYPE}" _cmake_build_type)
49     if (_cmake_build_type STREQUAL "ASAN")
50         set(MEMORYCHECK_TYPE "AddressSanitizer")
51     endif()
52     include(CTest)
53     if(_cmake_build_type STREQUAL "ASAN")
54         # AddressSanitizer support in CTest
55         # does not work without this...
56         set(_ctest_config_file "${PROJECT_BINARY_DIR}/DartConfiguration.tcl")
57         file(STRINGS ${_ctest_config_file} _existing REGEX "^CMakeCommand: ")
58         if (NOT _existing)
59             file(APPEND ${_ctest_config_file} "\nCMakeCommand: ${CMAKE_COMMAND}\n")
60         endif()
61     endif()
62 endmacro()
64 function (gmx_get_test_prefix_cmd VAR)
65     set(_options IGNORE_LEAKS)
66     cmake_parse_arguments(ARG "${_options}" "" "" ${ARGN})
67     set(_opts "")
68     if (ARG_IGNORE_LEAKS OR APPLE)
69         list(APPEND _opts "detect_leaks=0")
70     endif()
71     set(_cmd "")
72     if (MEMORYCHECK_TYPE STREQUAL "AddressSanitizer")
73         string(REPLACE ";" " " _opts "${_opts}")
74         set(_cmd ${PROJECT_SOURCE_DIR}/cmake/with_asan_opts.sh ${_opts} --)
75     endif()
76     set(${VAR} "${_cmd}" PARENT_SCOPE)
77 endfunction()