Environment variable docs maintenance
[gromacs.git] / cmake / gmxManageCycleCounters.cmake
blobdf3f0c735a9ff52d493afabb048fa9e1974d9ef6
2 # This file is part of the GROMACS molecular simulation package.
4 # Copyright (c) 2012,2013,2014,2015,2016, 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 # - Decide whether to use CPU cycle counters
37 # gmx_manage_cycle_counters()
39 # By default, we enable GMX_CYCLECOUNTERS for all architectures except ARMv7.
40 # On ARMv7, we enable it if we are not cross-compiling and can run a small
41 # test to confirm that the support is present in the kernel, otherwise we
42 # disable it.
44 macro(gmx_manage_cycle_counters)
46     if(NOT DEFINED GMX_CYCLECOUNTERS)
48         if(GMX_TARGET_ARMV7)
50             if(NOT CMAKE_CROSSCOMPILING)
52                 try_run(ARMV7_COUNTER_RUN_VAR ARMV7_COUNTER_COMPILE_VAR
53                         ${CMAKE_BINARY_DIR} "${CMAKE_SOURCE_DIR}/cmake/TestARMv7CycleCounters.cpp")
55                 # Enable cycle counter usage if the test ran fine and exited with 0 return code
56                 if(${ARMV7_COUNTER_COMPILE_VAR} AND ("${ARMV7_COUNTER_RUN_VAR}" EQUAL "0"))
57                     set(GMX_CYCLECOUNTERS ON CACHE BOOL "Use CPU cycle counters timing")
58                 else()
59                     set(GMX_CYCLECOUNTERS OFF CACHE BOOL "Use CPU cycle counters for timing")
60                 endif()
62             else()
64                 # Disable cycle counters when cross-compiling for ARMv7
65                 set(GMX_CYCLECOUNTERS OFF CACHE BOOL "Use CPU cycle counters for timing")
67             endif()
69         else()
71             # For now we (try to) enable cycle counters on all other platforms
72             set(GMX_CYCLECOUNTERS ON CACHE BOOL "Use CPU cycle counters timing")
74         endif()
76         mark_as_advanced(GMX_CYCLECOUNTERS)
78     endif()
80 endmacro()