Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Convert the unit tests of xbt::config to Catch2.
[simgrid.git] / tools / cmake / Flags.cmake
1 ##
2 ## This file is in charge of setting our paranoid flags with regard to warnings and optimization.
3 ##
4 ##   It is only used for gcc and clang. MSVC builds don't load this file.
5 ##
6 ##   These flags do break some classical CMake tests, so you don't
7 ##   want to do so before the very end of the configuration.
8 ##
9 ##   Other compiler flags (C/C++ standard version) are tested and set
10 ##   by the beginning of the configuration, directly in ~/CMakeList.txt
11
12 set(warnCFLAGS "")
13 set(optCFLAGS "")
14 set(warnCXXFLAGS "")
15
16 if(enable_compile_warnings)
17   set(warnCFLAGS "-fno-common -Wall -Wunused -Wmissing-declarations -Wpointer-arith -Wchar-subscripts -Wcomment -Wformat -Wwrite-strings -Wno-unused-function -Wno-unused-parameter -Wno-strict-aliasing")
18   if(CMAKE_COMPILER_IS_GNUCC AND (NOT (CMAKE_C_COMPILER_VERSION VERSION_LESS "5.0")))
19     set(warnCFLAGS "${warnCFLAGS} -Wformat-signedness")
20   endif()
21   if(CMAKE_COMPILER_IS_GNUCC)
22     set(warnCFLAGS "${warnCFLAGS} -Wclobbered -Wno-error=clobbered  -Wno-unused-local-typedefs -Wno-error=attributes -Wno-error=maybe-uninitialized")
23   endif()
24   if (CMAKE_CXX_COMPILER_ID MATCHES "Intel")
25     # ignore remark  #1418: external function definition with no prior declaration
26     # 3179: deprecated conversion of string literal to char* (should be const char*)
27     # 191: type qualifier is meaningless on cast type
28     # 597: entity-kind "entity" will not be called for implicit or explicit conversions
29     set(warnCFLAGS "${warnCFLAGS} -wd1418 -wd191 -wd3179 -ww597")
30   endif()
31
32   set(warnCXXFLAGS "${warnCFLAGS} -Wall -Wextra -Wunused -Wmissing-declarations -Wpointer-arith -Wchar-subscripts -Wcomment -Wformat -Wwrite-strings -Wno-unused-function -Wno-unused-parameter -Wno-strict-aliasing")
33   if(CMAKE_COMPILER_IS_GNUCXX AND (NOT (CMAKE_CXX_COMPILER_VERSION VERSION_LESS "5.0")))
34     set(warnCFLAGS "${warnCFLAGS} -Wformat-signedness")
35   endif()
36   if(CMAKE_COMPILER_IS_GNUCXX)
37     set(warnCXXFLAGS "${warnCXXFLAGS} -Wclobbered -Wno-error=clobbered  -Wno-unused-local-typedefs -Wno-error=attributes -Wno-error=maybe-uninitialized")
38   endif()
39   if (CMAKE_CXX_COMPILER_ID MATCHES "Clang")
40     # don't care about class that become struct, avoid issue of empty C structs
41     # size (coming from libunwind.h)
42     set(warnCXXFLAGS "${warnCXXFLAGS} -Wno-mismatched-tags -Wno-extern-c-compat")
43   endif()
44
45   # the one specific to C but refused by C++
46   set(warnCFLAGS "${warnCFLAGS} -Wmissing-prototypes")
47
48   if(CMAKE_Fortran_COMPILER_ID MATCHES "GCC|PGI")
49     set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} -Wall")
50   endif()
51   if(CMAKE_Fortran_COMPILER_ID MATCHES "Intel")
52     set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} -warn all")
53   endif()
54   set(CMAKE_JAVA_COMPILE_FLAGS "-Xlint")
55 endif()
56
57 # NDEBUG gives a lot of "initialized but unused variables" errors. Don't die anyway.
58 if(enable_compile_warnings AND enable_debug)
59   set(warnCFLAGS "${warnCFLAGS} -Werror")
60   set(warnCXXFLAGS "${warnCXXFLAGS} -Werror")
61 endif()
62
63 # Activate the warnings on #if FOOBAR when FOOBAR has no value
64 # It breaks on FreeBSD within Boost headers, so activate this only in Pure Hardcore debug mode.
65 if(enable_maintainer_mode)
66   set(warnCFLAGS "${warnCFLAGS} -Wundef")
67   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wundef")
68 endif()
69
70 # Se the optimisation flags
71 # NOTE, we should CMAKE_BUILD_TYPE for this
72 if(enable_compile_optimizations)
73   set(optCFLAGS "-O3 -funroll-loops -fno-strict-aliasing ")
74 else()
75   set(optCFLAGS "-O0 ")
76 endif()
77 if(enable_compile_optimizations AND CMAKE_COMPILER_IS_GNUCC
78     AND (NOT enable_model-checking))
79   # This is redundant (already in -03):
80   set(optCFLAGS "${optCFLAGS} -finline-functions ")
81 endif()
82
83 # Do not leak the current directory into the binaries
84 if(CMAKE_COMPILER_IS_GNUCC)
85   execute_process(COMMAND realpath --relative-to=${CMAKE_BINARY_DIR} ${CMAKE_SOURCE_DIR}
86     RESULT_VARIABLE RESULT OUTPUT_VARIABLE RELATIVE_SOURCE_DIR ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
87   if(RESULT EQUAL 0)
88     message(STATUS "Relative source directory is \"${RELATIVE_SOURCE_DIR}\".")
89   else()
90     message(WARNING "Failed to find relative source directory. Using \".\".")
91     set(RELATIVE_SOURCE_DIR ".")
92   endif()
93   set(optCFLAGS "${optCFLAGS} -fdebug-prefix-map=${CMAKE_SOURCE_DIR}=${RELATIVE_SOURCE_DIR}")
94 endif()
95
96 # Configure LTO
97 # NOTE, cmake 3.0 has a INTERPROCEDURAL_OPTIMIZATION target
98 #       property for this (http://www.cmake.org/cmake/help/v3.0/prop_tgt/INTERPROCEDURAL_OPTIMIZATION.html)
99 if(enable_lto) # User wants LTO. Try if we can do that
100   set(enable_lto OFF)
101   if(enable_compile_optimizations
102       AND CMAKE_COMPILER_IS_GNUCC
103       AND (NOT enable_model-checking))
104     # On windows, we need 4.8 or higher to enable lto because of http://gcc.gnu.org/bugzilla/show_bug.cgi?id=50293
105     #   We are experiencing assertion failures even with 4.8 on MinGW.
106     #   Push the support forward: will see if 4.9 works when we test it.
107     #
108     # On Linux, we got the following with GCC 4.8.4 on Centos and Ubuntu
109     #    lto1: internal compiler error: in output_die, at dwarf2out.c:8478
110     #    Please submit a full bug report, with preprocessed source if appropriate.
111     # So instead, we push the support forward
112
113     if ( (CMAKE_C_COMPILER_VERSION VERSION_GREATER "4.8.5")
114          AND (LINKER_VERSION VERSION_GREATER "2.22"))
115       set(enable_lto ON)
116     endif()
117   endif()
118   if(enable_lto)
119     message(STATUS "LTO seems usable.")
120   else()
121     if(NOT enable_compile_optimizations)
122       message(STATUS "LTO disabled: Compile-time optimizations turned off.")
123     else()
124       if(enable_model-checking)
125         message(STATUS "LTO disabled when compiling with model-checking.")
126       else()
127         message(STATUS "LTO does not seem usable -- try updating your build chain.")
128       endif()
129     endif()
130   endif()
131 else()
132   message(STATUS "LTO disabled on the command line.")
133 endif()
134 if(enable_lto) # User wants LTO, and it seems usable. Go for it
135   set(optCFLAGS "${optCFLAGS} -flto ")
136   # See https://gcc.gnu.org/wiki/LinkTimeOptimizationFAQ#ar.2C_nm_and_ranlib:
137   # "Since version 4.9 gcc produces slim object files that only contain
138   # the intermediate representation. In order to handle archives of
139   # these objects you have to use the gcc wrappers:
140   # gcc-ar, gcc-nm and gcc-ranlib."
141   if(${CMAKE_C_COMPILER_ID} STREQUAL "GNU"
142       AND CMAKE_C_COMPILER_VERSION VERSION_GREATER "4.8")
143     set (CMAKE_AR gcc-ar)
144     set (CMAKE_RANLIB gcc-ranlib)
145   endif()
146 endif()
147
148 if(enable_model-checking AND enable_compile_optimizations)
149   # Forget it, do not optimize the code (because it confuses the MC):
150   set(optCFLAGS "-O0 ")
151   # But you can still optimize this:
152   foreach(s
153       src/simix/popping.cpp src/simix/popping_generated.cpp src/simix/smx_global.cpp
154       ${SURF_SRC} ${TRACING_SRC} ${XBT_SRC}
155       ${MC_SRC_BASE} ${MC_SRC})
156       set (mcCFLAGS "-O3  -funroll-loops -fno-strict-aliasing")
157        if(CMAKE_COMPILER_IS_GNUCC)
158          set (mcCFLAGS "${mcCFLAGS} -finline-functions")
159       endif()
160       set_source_files_properties(${s} PROPERTIES COMPILE_FLAGS ${mcCFLAGS})
161   endforeach()
162 endif()
163
164 if (CMAKE_C_COMPILER_ID MATCHES "Intel")
165   # honor parentheses when determining the order of expression evaluation.
166   set(optCFLAGS "${optCFLAGS} -fprotect-parens ")
167 endif()
168
169 if(NOT enable_debug)
170   set(CMAKE_C_FLAGS "-DNDEBUG ${CMAKE_C_FLAGS}")
171   set(CMAKE_CXX_FLAGS "-DNDEBUG ${CMAKE_CXX_FLAGS}")
172 endif()
173
174 set(CMAKE_C_FLAGS   "${warnCFLAGS} ${CMAKE_C_FLAGS}   ${optCFLAGS}")
175 set(CMAKE_CXX_FLAGS "${warnCXXFLAGS} ${CMAKE_CXX_FLAGS} ${optCFLAGS}")
176
177 # Try to make Mac a bit more complient to open source standards
178 if(CMAKE_SYSTEM_NAME MATCHES "Darwin")
179   set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -D_XOPEN_SOURCE=700 -D_DARWIN_C_SOURCE")
180 endif()
181
182 # Avoid a failure seen with gcc 7.2.0 and ns3 3.27
183 if(enable_ns3)
184   set_source_files_properties(src/surf/network_ns3.cpp PROPERTIES COMPILE_FLAGS " -Wno-unused-local-typedef")
185 endif()
186
187 set(TESH_OPTION "")
188 if(enable_coverage)
189   find_program(GCOV_PATH gcov)
190   if(GCOV_PATH)
191     set(COVERAGE_COMMAND "${GCOV_PATH}" CACHE TYPE FILEPATH FORCE)
192     set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DCOVERAGE")
193     set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fprofile-arcs -ftest-coverage")
194     set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fprofile-arcs -ftest-coverage")
195     set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} -fprofile-arcs -ftest-coverage")
196     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DCOVERAGE")
197     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fprofile-arcs -ftest-coverage")
198     add_definitions(-fprofile-arcs -ftest-coverage)
199   endif()
200 endif()
201
202 if(enable_address_sanitizer)
203     set(CMAKE_C_FLAGS   "${CMAKE_C_FLAGS} -fsanitize=address -fno-omit-frame-pointer")
204     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=address -fno-omit-frame-pointer")
205     set(CMAKE_C_LINK_FLAGS "${CMAKE_C_LINK_FLAGS} -fsanitize=address")
206     set(TESH_OPTION --enable-sanitizers)
207     try_compile(HAVE_SANITIZER_ADDRESS ${CMAKE_BINARY_DIR} ${CMAKE_HOME_DIRECTORY}/tools/cmake/test_prog/prog_asan.cpp)
208     try_compile(HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT ${CMAKE_BINARY_DIR} ${CMAKE_HOME_DIRECTORY}/tools/cmake/test_prog/prog_asan.cpp
209       COMPILE_DEFINITIONS -DCHECK_FIBER_SUPPORT)
210 else()
211     set(HAVE_SANITIZER_ADDRESS FALSE CACHE INTERNAL "")
212     set(HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT FALSE CACHE INTERNAL "")
213 endif()
214
215 if(enable_thread_sanitizer)
216     set(CMAKE_C_FLAGS   "${CMAKE_C_FLAGS} -fsanitize=thread -fno-omit-frame-pointer -no-pie")
217     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=thread -fno-omit-frame-pointer -no-pie")
218     set(CMAKE_C_LINK_FLAGS "${CMAKE_C_LINK_FLAGS} -fsanitize=thread -no-pie")
219     set(HAVE_SANITIZER_THREAD TRUE CACHE INTERNAL "")
220 else()
221     set(HAVE_SANITIZER_THREAD FALSE CACHE INTERNAL "")
222 endif()
223
224 if(enable_undefined_sanitizer)
225     set(CMAKE_C_FLAGS   "${CMAKE_C_FLAGS} -fsanitize=undefined -fno-omit-frame-pointer")
226     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=undefined -fno-omit-frame-pointer")
227     set(CMAKE_C_LINK_FLAGS "${CMAKE_C_LINK_FLAGS} -fsanitize=undefined")
228 endif()
229
230 if(NOT $ENV{CFLAGS} STREQUAL "")
231   message(STATUS "Add CFLAGS: \"$ENV{CFLAGS}\" to CMAKE_C_FLAGS")
232   set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} $ENV{CFLAGS}")
233 endif()
234
235 if(NOT $ENV{CXXFLAGS} STREQUAL "")
236   message(STATUS "Add CXXFLAGS: \"$ENV{CXXFLAGS}\" to CMAKE_CXX_FLAGS")
237   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} $ENV{CXXFLAGS}")
238 endif()
239
240 if(NOT $ENV{LDFLAGS} STREQUAL "")
241   message(STATUS "Add LDFLAGS: \"$ENV{LDFLAGS}\" to CMAKE_C_LINK_FLAGS")
242   set(CMAKE_C_LINK_FLAGS "${CMAKE_C_LINK_FLAGS} $ENV{LDFLAGS}")
243 endif()
244
245 if(MINGW)
246   # http://stackoverflow.com/questions/10452262/create-64-bit-jni-under-windows
247   # We don't want to ship libgcc_s_seh-1.dll nor libstdc++-6.dll
248   set(CMAKE_C_FLAGS   "${CMAKE_C_FLAGS}   -static-libgcc")
249   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -static-libgcc -static-libstdc++")
250   set(CMAKE_SHARED_LIBRARY_LINK_C_FLAGS   "${CMAKE_SHARED_LIBRARY_LINK_C_FLAGS} -static-libgcc")
251   set(CMAKE_SHARED_LIBRARY_LINK_CXX_FLAGS "${CMAKE_SHARED_LIBRARY_LINK_CXX_FLAGS} -static-libgcc -static-libstdc++")
252
253   # JNI searches for stdcalls
254   set(CMAKE_C_FLAGS   "${CMAKE_C_FLAGS}   -Wl,--add-stdcall-alias")
255   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wl,--add-stdcall-alias")
256   set(CMAKE_SHARED_LIBRARY_LINK_C_FLAGS "${CMAKE_SHARED_LIBRARY_LINK_C_FLAGS} -Wl,--add-stdcall-alias")
257   set(CMAKE_SHARED_LIBRARY_LINK_CXX_FLAGS "${CMAKE_SHARED_LIBRARY_LINK_CXX_FLAGS} -Wl,--add-stdcall-alias")
258
259   # Specify the data model that we are using (yeah it may help Java)
260   if(CMAKE_SIZEOF_VOID_P EQUAL 4) # 32 bits
261     set(CMAKE_C_FLAGS   "${CMAKE_C_FLAGS}   -m32")
262     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -m32")
263   else()
264     set(CMAKE_C_FLAGS   "${CMAKE_C_FLAGS}   -m64")
265     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -m64")
266   endif()
267 endif()