Merge "Merge branch release-5-1 into release-2016" into release-2016
[gromacs.git] / cmake / gmxSetBuildInformation.cmake
blobf064ba419f8d6d537aee25a2d935769ee6c9ecc0
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 # - Check the username performing the build, as well as date and time
37 # gmx_set_build_information()
39 # The macro variables will be set to the user/host/cpu used for configuration,
40 # or anonymous/unknown if it cannot be detected (windows)
42 # BUILD_TIME
43 # BUILD_USER
44 # BUILD_HOST
45 # BUILD_CPU_VENDOR
46 # BUILD_CPU_BRAND
47 # BUILD_CPU_FAMILY
48 # BUILD_CPU_MODEL
49 # BUILD_CPU_STEPPING
50 # BUILD_CPU_FEATURES
53 # we rely on inline asm support for GNU!
54 include(gmxTestInlineASM)
56 macro(gmx_set_build_information)
57     IF(NOT DEFINED BUILD_USER)
59     gmx_test_inline_asm_gcc_x86(GMX_X86_GCC_INLINE_ASM)
61     if(GMX_X86_GCC_INLINE_ASM)
62         set(GCC_INLINE_ASM_DEFINE "-DGMX_X86_GCC_INLINE_ASM=1")
63     else()
64         set(GCC_INLINE_ASM_DEFINE "-DGMX_X86_GCC_INLINE_ASM=0")
65     endif()
67     message(STATUS "Setting build user/date/host/cpu information")
68     if(CMAKE_HOST_UNIX)
69         execute_process( COMMAND date     OUTPUT_VARIABLE TMP_TIME    OUTPUT_STRIP_TRAILING_WHITESPACE)
70         execute_process( COMMAND whoami   OUTPUT_VARIABLE TMP_USER       OUTPUT_STRIP_TRAILING_WHITESPACE)
71         execute_process( COMMAND hostname OUTPUT_VARIABLE TMP_HOSTNAME   OUTPUT_STRIP_TRAILING_WHITESPACE)
72         set(BUILD_USER    "${TMP_USER}\@${TMP_HOSTNAME} [CMAKE]" CACHE INTERNAL "Build user")
73         set(BUILD_TIME    "${TMP_TIME}" CACHE INTERNAL "Build date & time")
74         execute_process( COMMAND uname -srm OUTPUT_VARIABLE TMP_HOST OUTPUT_STRIP_TRAILING_WHITESPACE)
75         set(BUILD_HOST    "${TMP_HOST}" CACHE INTERNAL "Build host & architecture")
76         message(STATUS "Setting build user & time - OK")
77     else()
78         set(BUILD_USER    "Anonymous\@unknown [CMAKE]" CACHE INTERNAL "Build user")
79         set(BUILD_TIME    "Unknown date" CACHE INTERNAL "Build date & time")
80         set(BUILD_HOST    "${CMAKE_HOST_SYSTEM} ${CMAKE_HOST_SYSTEM_PROCESSOR}" CACHE INTERNAL "Build host & architecture")
81         message(STATUS "Setting build user & time - not on Unix, using anonymous")
82     endif()
84     # Set up some defaults that will usually be overridden
85     if(CMAKE_CROSSCOMPILING)
86         set(_reason ", cross-compiled")
87     endif()
88     set(OUTPUT_CPU_VENDOR   "Unknown${_reason}")
89     set(OUTPUT_CPU_BRAND    "Unknown${_reason}")
90     set(OUTPUT_CPU_FAMILY   "0")
91     set(OUTPUT_CPU_MODEL    "0")
92     set(OUTPUT_CPU_STEPPING "0")
93     set(OUTPUT_CPU_FEATURES "Unknown${_reason}")
94     unset(_reason)
96     if(NOT CMAKE_CROSSCOMPILING)
97         # Get CPU information, e.g. for deciding what SIMD support probably exists
98         set(_compile_definitions "${GCC_INLINE_ASM_DEFINE} -I${CMAKE_SOURCE_DIR}/src -DGMX_CPUINFO_STANDALONE ${GMX_STDLIB_CXX_FLAGS}")
99         if(GMX_TARGET_X86)
100             set(_compile_definitions "${_compile_definitions} -DGMX_TARGET_X86")
101         endif()
103         set(GMX_BUILDINFORMATION_BINARY "${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/GmxBuildInformation${CMAKE_EXECUTABLE_SUFFIX}")
104         set(LINK_LIBRARIES "${GMX_STDLIB_LIBRARIES}")
105         # TODO Extract this try_compile to a helper function, because
106         # it duplicates code in gmxDetectSimd.cmake
107         try_compile(GMX_BUILDINFORMATION_COMPILED
108             "${CMAKE_CURRENT_BINARY_DIR}"
109             "${CMAKE_CURRENT_SOURCE_DIR}/src/gromacs/hardware/cpuinfo.cpp"
110             COMPILE_DEFINITIONS "${_compile_definitions}"
111             CMAKE_FLAGS "-DLINK_LIBRARIES=${LINK_LIBRARIES}"
112             OUTPUT_VARIABLE GMX_BUILDINFORMATION_COMPILED_OUTPUT
113             COPY_FILE ${GMX_BUILDINFORMATION_BINARY})
114         unset(_compile_definitions)
116         if(GMX_BUILDINFORMATION_COMPILED)
117             # TODO Extract this duplication to a helper function (also
118             # from gmxDetectSimd.cmake)
119             if(NOT DEFINED GMX_BUILDINFORMATION_RUN_VENDOR)
120                 execute_process(COMMAND ${GMX_BUILDINFORMATION_BINARY} "-vendor"
121                     RESULT_VARIABLE GMX_BUILDINFORMATION_RUN_VENDOR
122                     OUTPUT_VARIABLE OUTPUT_TMP
123                     ERROR_QUIET)
124                 set(GMX_BUILDINFORMATION_RUN_VENDOR "${GMX_BUILDINFORMATION_RUN_VENDOR}" CACHE INTERNAL "Result of running cpuinfo code with arg -vendor")
125                 if(GMX_BUILDINFORMATION_RUN_VENDOR EQUAL 0)
126                     string(STRIP "${OUTPUT_TMP}" OUTPUT_CPU_VENDOR)
127                 endif()
128             endif()
129             if(NOT DEFINED GMX_BUILDINFORMATION_RUN_BRAND)
130                 execute_process(COMMAND ${GMX_BUILDINFORMATION_BINARY} "-brand"
131                     RESULT_VARIABLE GMX_BUILDINFORMATION_RUN_BRAND
132                     OUTPUT_VARIABLE OUTPUT_TMP
133                     ERROR_QUIET)
134                 set(GMX_BUILDINFORMATION_RUN_BRAND "${GMX_BUILDINFORMATION_RUN_BRAND}" CACHE INTERNAL "Result of running cpuinfo code with arg -brand")
135                 if(GMX_BUILDINFORMATION_RUN_BRAND EQUAL 0)
136                     string(STRIP "${OUTPUT_TMP}" OUTPUT_CPU_BRAND)
137                 endif()
138             endif()
139             if(NOT DEFINED GMX_BUILDINFORMATION_RUN_FAMILY)
140                 execute_process(COMMAND ${GMX_BUILDINFORMATION_BINARY} "-family"
141                     RESULT_VARIABLE GMX_BUILDINFORMATION_RUN_FAMILY
142                     OUTPUT_VARIABLE OUTPUT_TMP
143                     ERROR_QUIET)
144                 set(GMX_BUILDINFORMATION_RUN_FAMILY "${GMX_BUILDINFORMATION_RUN_FAMILY}" CACHE INTERNAL "Result of running cpuinfo code with arg -family")
145                 if(GMX_BUILDINFORMATION_RUN_FAMILY EQUAL 0)
146                     string(STRIP "${OUTPUT_TMP}" OUTPUT_CPU_FAMILY)
147                 endif()
148             endif()
149             if(NOT DEFINED GMX_BUILDINFORMATION_RUN_MODEL)
150                 execute_process(COMMAND ${GMX_BUILDINFORMATION_BINARY} "-model"
151                     RESULT_VARIABLE GMX_BUILDINFORMATION_RUN_MODEL
152                     OUTPUT_VARIABLE OUTPUT_TMP
153                     ERROR_QUIET)
154                 set(GMX_BUILDINFORMATION_RUN_MODEL "${GMX_BUILDINFORMATION_RUN_MODEL}" CACHE INTERNAL "Result of running cpuinfo code with arg -model")
155                 if(GMX_BUILDINFORMATION_RUN_MODEL EQUAL 0)
156                     string(STRIP "${OUTPUT_TMP}" OUTPUT_CPU_MODEL)
157                 endif()
158             endif()
159             if(NOT DEFINED GMX_BUILDINFORMATION_RUN_STEPPING)
160                 execute_process(COMMAND ${GMX_BUILDINFORMATION_BINARY} "-stepping"
161                     RESULT_VARIABLE GMX_BUILDINFORMATION_RUN_STEPPING
162                     OUTPUT_VARIABLE OUTPUT_TMP
163                     ERROR_QUIET)
164                 set(GMX_BUILDINFORMATION_RUN_STEPPING "${GMX_BUILDINFORMATION_RUN_STEPPING}" CACHE INTERNAL "Result of running cpuinfo code with arg -stepping")
165                 if(GMX_BUILDINFORMATION_RUN_STEPPING EQUAL 0)
166                     string(STRIP "${OUTPUT_TMP}" OUTPUT_CPU_STEPPING)
167                 endif()
168             endif()
169             if(NOT DEFINED GMX_BUILDINFORMATION_RUN_FEATURES)
170                 execute_process(COMMAND ${GMX_BUILDINFORMATION_BINARY} "-features"
171                     RESULT_VARIABLE GMX_BUILDINFORMATION_RUN_FEATURES
172                     OUTPUT_VARIABLE OUTPUT_TMP
173                     ERROR_QUIET)
174                 set(GMX_BUILDINFORMATION_RUN_FEATURES "${GMX_BUILDINFORMATION_RUN_FEATURES}" CACHE INTERNAL "Result of running cpuinfo code with arg -features")
175                 if(GMX_BUILDINFORMATION_RUN_FEATURES EQUAL 0)
176                     string(STRIP "${OUTPUT_TMP}" OUTPUT_CPU_FEATURES)
177                 endif()
178             endif()
179         endif()
180     endif()
182     set(BUILD_CPU_VENDOR   "${OUTPUT_CPU_VENDOR}"   CACHE INTERNAL "Build CPU vendor")
183     set(BUILD_CPU_BRAND    "${OUTPUT_CPU_BRAND}"    CACHE INTERNAL "Build CPU brand")
184     set(BUILD_CPU_FAMILY   "${OUTPUT_CPU_FAMILY}"   CACHE INTERNAL "Build CPU family")
185     set(BUILD_CPU_MODEL    "${OUTPUT_CPU_MODEL}"    CACHE INTERNAL "Build CPU model")
186     set(BUILD_CPU_STEPPING "${OUTPUT_CPU_STEPPING}" CACHE INTERNAL "Build CPU stepping")
187     set(BUILD_CPU_FEATURES "${OUTPUT_CPU_FEATURES}" CACHE INTERNAL "Build CPU features")
189     ENDIF(NOT DEFINED BUILD_USER)
190 endmacro(gmx_set_build_information)