2cec270e96ddb63a2fdc3eb20aad463c74e5307c
[oota-llvm.git] / cmake / modules / HandleLLVMOptions.cmake
1 # This CMake module is responsible for interpreting the user defined LLVM_
2 # options and executing the appropriate CMake commands to realize the users'
3 # selections.
4
5 include(AddLLVMDefinitions)
6 include(CheckCCompilerFlag)
7 include(CheckCXXCompilerFlag)
8
9 if( CMAKE_COMPILER_IS_GNUCXX )
10   set(LLVM_COMPILER_IS_GCC_COMPATIBLE ON)
11 elseif( MSVC )
12   set(LLVM_COMPILER_IS_GCC_COMPATIBLE OFF)
13 elseif( "${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang" )
14   set(LLVM_COMPILER_IS_GCC_COMPATIBLE ON)
15 endif()
16
17 if( LLVM_ENABLE_ASSERTIONS )
18   # MSVC doesn't like _DEBUG on release builds. See PR 4379.
19   if( NOT MSVC )
20     add_definitions( -D_DEBUG )
21   endif()
22   # On non-Debug builds cmake automatically defines NDEBUG, so we
23   # explicitly undefine it:
24   if( NOT uppercase_CMAKE_BUILD_TYPE STREQUAL "DEBUG" )
25     add_definitions( -UNDEBUG )
26     # Also remove /D NDEBUG to avoid MSVC warnings about conflicting defines.
27     string (REGEX REPLACE "(^| )[/-]D *NDEBUG($| )" " "
28       CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE}")
29   endif()
30 else()
31   if( NOT uppercase_CMAKE_BUILD_TYPE STREQUAL "RELEASE" )
32     if( NOT MSVC_IDE AND NOT XCODE )
33       add_definitions( -DNDEBUG )
34     endif()
35   endif()
36 endif()
37
38 if(WIN32)
39   if(CYGWIN)
40     set(LLVM_ON_WIN32 0)
41     set(LLVM_ON_UNIX 1)
42   else(CYGWIN)
43     set(LLVM_ON_WIN32 1)
44     set(LLVM_ON_UNIX 0)
45   endif(CYGWIN)
46   set(LTDL_SHLIB_EXT ".dll")
47   set(EXEEXT ".exe")
48   # Maximum path length is 160 for non-unicode paths
49   set(MAXPATHLEN 160)
50 else(WIN32)
51   if(UNIX)
52     set(LLVM_ON_WIN32 0)
53     set(LLVM_ON_UNIX 1)
54     if(APPLE)
55       set(LTDL_SHLIB_EXT ".dylib")
56     else(APPLE)
57       set(LTDL_SHLIB_EXT ".so")
58     endif(APPLE)
59     set(EXEEXT "")
60     # FIXME: Maximum path length is currently set to 'safe' fixed value
61     set(MAXPATHLEN 2024)
62   else(UNIX)
63     MESSAGE(SEND_ERROR "Unable to determine platform")
64   endif(UNIX)
65 endif(WIN32)
66
67 function(add_flag_or_print_warning flag)
68   check_c_compiler_flag(${flag} C_SUPPORTS_FLAG)
69   check_cxx_compiler_flag(${flag} CXX_SUPPORTS_FLAG)
70   if (C_SUPPORTS_FLAG AND CXX_SUPPORTS_FLAG)
71     message(STATUS "Building with ${flag}")
72     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${flag}" PARENT_SCOPE)
73     set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${flag}" PARENT_SCOPE)
74   else()
75     message(WARNING "${flag} is not supported.")
76   endif()
77 endfunction()
78
79 function(append value)
80   foreach(variable ${ARGN})
81     set(${variable} "${${variable}} ${value}" PARENT_SCOPE)
82   endforeach(variable)
83 endfunction()
84
85 function(append_if condition value)
86   if (${condition})
87     foreach(variable ${ARGN})
88       set(${variable} "${${variable}} ${value}" PARENT_SCOPE)
89     endforeach(variable)
90   endif()
91 endfunction()
92
93 macro(add_flag_if_supported flag)
94   check_c_compiler_flag(${flag} C_SUPPORTS_FLAG)
95   append_if(C_SUPPORTS_FLAG "${flag}" CMAKE_C_FLAGS)
96   check_cxx_compiler_flag(${flag} CXX_SUPPORTS_FLAG)
97   append_if(CXX_SUPPORTS_FLAG "${flag}" CMAKE_CXX_FLAGS)
98 endmacro()
99
100 if( LLVM_ENABLE_PIC )
101   if( XCODE )
102     # Xcode has -mdynamic-no-pic on by default, which overrides -fPIC. I don't
103     # know how to disable this, so just force ENABLE_PIC off for now.
104     message(WARNING "-fPIC not supported with Xcode.")
105   elseif( WIN32 OR CYGWIN)
106     # On Windows all code is PIC. MinGW warns if -fPIC is used.
107   else()
108     add_flag_or_print_warning("-fPIC")
109
110     if( WIN32 OR CYGWIN)
111       # MinGW warns if -fvisibility-inlines-hidden is used.
112     else()
113       check_cxx_compiler_flag("-fvisibility-inlines-hidden" SUPPORTS_FVISIBILITY_INLINES_HIDDEN_FLAG)
114       append_if(SUPPORTS_FVISIBILITY_INLINES_HIDDEN_FLAG "-fvisibility-inlines-hidden" CMAKE_CXX_FLAGS)
115     endif()
116   endif()
117 endif()
118
119 if( CMAKE_SIZEOF_VOID_P EQUAL 8 AND NOT WIN32 )
120   # TODO: support other platforms and toolchains.
121   if( LLVM_BUILD_32_BITS )
122     message(STATUS "Building 32 bits executables and libraries.")
123     add_llvm_definitions( -m32 )
124     set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -m32")
125     set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -m32")
126     set(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} -m32")
127   endif( LLVM_BUILD_32_BITS )
128 endif( CMAKE_SIZEOF_VOID_P EQUAL 8 AND NOT WIN32 )
129
130 # On Win32 using MS tools, provide an option to set the number of parallel jobs
131 # to use.
132 if( MSVC_IDE )
133   set(LLVM_COMPILER_JOBS "0" CACHE STRING
134     "Number of parallel compiler jobs. 0 means use all processors. Default is 0.")
135   if( NOT LLVM_COMPILER_JOBS STREQUAL "1" )
136     if( LLVM_COMPILER_JOBS STREQUAL "0" )
137       add_llvm_definitions( /MP )
138     else()
139       if (MSVC10)
140         message(FATAL_ERROR
141           "Due to a bug in CMake only 0 and 1 is supported for "
142           "LLVM_COMPILER_JOBS when generating for Visual Studio 2010")
143       else()
144         message(STATUS "Number of parallel compiler jobs set to " ${LLVM_COMPILER_JOBS})
145         add_llvm_definitions( /MP${LLVM_COMPILER_JOBS} )
146       endif()
147     endif()
148   else()
149     message(STATUS "Parallel compilation disabled")
150   endif()
151 endif()
152
153 if( MSVC )
154   include(ChooseMSVCCRT)
155
156   if( MSVC10 )
157     # MSVC 10 will complain about headers in the STL not being exported, but
158     # will not complain in MSVC 11.
159     add_llvm_definitions(
160       -wd4275 # Suppress 'An exported class was derived from a class that was not exported.'
161     )
162   elseif( MSVC11 )
163     add_llvm_definitions(-D_VARIADIC_MAX=10)
164   endif()
165   
166   # Add definitions that make MSVC much less annoying.
167   add_llvm_definitions(
168     # For some reason MS wants to deprecate a bunch of standard functions...
169     -D_CRT_SECURE_NO_DEPRECATE
170     -D_CRT_SECURE_NO_WARNINGS
171     -D_CRT_NONSTDC_NO_DEPRECATE
172     -D_CRT_NONSTDC_NO_WARNINGS
173     -D_SCL_SECURE_NO_DEPRECATE
174     -D_SCL_SECURE_NO_WARNINGS
175
176     # Disabled warnings.
177     -wd4146 # Suppress 'unary minus operator applied to unsigned type, result still unsigned'
178     -wd4180 # Suppress 'qualifier applied to function type has no meaning; ignored'
179     -wd4244 # Suppress ''argument' : conversion from 'type1' to 'type2', possible loss of data'
180     -wd4267 # Suppress ''var' : conversion from 'size_t' to 'type', possible loss of data'
181     -wd4345 # Suppress 'behavior change: an object of POD type constructed with an initializer of the form () will be default-initialized'
182     -wd4351 # Suppress 'new behavior: elements of array 'array' will be default initialized'
183     -wd4355 # Suppress ''this' : used in base member initializer list'
184     -wd4503 # Suppress ''identifier' : decorated name length exceeded, name was truncated'
185     -wd4624 # Suppress ''derived class' : destructor could not be generated because a base class destructor is inaccessible'
186     -wd4800 # Suppress ''type' : forcing value to bool 'true' or 'false' (performance warning)'
187     -wd4291 # Suppress ''declaration' : no matching operator delete found; memory will not be freed if initialization throws an exception'
188     
189     # Promoted warnings.
190     -w14062 # Promote 'enumerator in switch of enum is not handled' to level 1 warning.
191
192     # Promoted warnings to errors.
193     -we4238 # Promote 'nonstandard extension used : class rvalue used as lvalue' to error.
194     )
195
196   # Enable warnings
197   if (LLVM_ENABLE_WARNINGS)
198     add_llvm_definitions( /W4 )
199     if (LLVM_ENABLE_PEDANTIC)
200       # No MSVC equivalent available
201     endif (LLVM_ENABLE_PEDANTIC)
202   endif (LLVM_ENABLE_WARNINGS)
203   if (LLVM_ENABLE_WERROR)
204     add_llvm_definitions( /WX )
205   endif (LLVM_ENABLE_WERROR)
206 elseif( LLVM_COMPILER_IS_GCC_COMPATIBLE )
207   if (LLVM_ENABLE_WARNINGS)
208     append("-Wall -W -Wno-unused-parameter -Wwrite-strings" CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
209
210     # Turn off missing field initializer warnings for gcc to avoid noise from
211     # false positives with empty {}. Turn them on otherwise (they're off by
212     # default for clang).
213     check_cxx_compiler_flag("-Wmissing-field-initializers" CXX_SUPPORTS_MISSING_FIELD_INITIALIZERS_FLAG)
214     if (CXX_SUPPORTS_MISSING_FIELD_INITIALIZERS_FLAG)
215       if (CMAKE_COMPILER_IS_GNUCXX)
216         append("-Wno-missing-field-initializers" CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
217       else()
218         append("-Wmissing-field-initializers" CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
219       endif()
220     endif()
221
222     append_if(LLVM_ENABLE_PEDANTIC "-pedantic -Wno-long-long" CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
223     check_cxx_compiler_flag("-Werror -Wcovered-switch-default" CXX_SUPPORTS_COVERED_SWITCH_DEFAULT_FLAG)
224     append_if(CXX_SUPPORTS_COVERED_SWITCH_DEFAULT_FLAG "-Wcovered-switch-default" CMAKE_CXX_FLAGS)
225     check_c_compiler_flag("-Werror -Wcovered-switch-default" C_SUPPORTS_COVERED_SWITCH_DEFAULT_FLAG)
226     append_if(C_SUPPORTS_COVERED_SWITCH_DEFAULT_FLAG "-Wcovered-switch-default" CMAKE_C_FLAGS)
227     append_if(USE_NO_UNINITIALIZED "-Wno-uninitialized" CMAKE_CXX_FLAGS)
228     append_if(USE_NO_MAYBE_UNINITIALIZED "-Wno-maybe-uninitialized" CMAKE_CXX_FLAGS)
229     check_cxx_compiler_flag("-Werror -Wnon-virtual-dtor" CXX_SUPPORTS_NON_VIRTUAL_DTOR_FLAG)
230     append_if(CXX_SUPPORTS_NON_VIRTUAL_DTOR_FLAG "-Wnon-virtual-dtor" CMAKE_CXX_FLAGS)
231   endif (LLVM_ENABLE_WARNINGS)
232   if (LLVM_ENABLE_WERROR)
233     add_llvm_definitions( -Werror )
234   endif (LLVM_ENABLE_WERROR)
235 endif( MSVC )
236
237 macro(append_common_sanitizer_flags)
238   # Append -fno-omit-frame-pointer and turn on debug info to get better
239   # stack traces.
240   add_flag_if_supported("-fno-omit-frame-pointer")
241   if (NOT uppercase_CMAKE_BUILD_TYPE STREQUAL "DEBUG" AND
242       NOT uppercase_CMAKE_BUILD_TYPE STREQUAL "RELWITHDEBINFO")
243     add_flag_if_supported("-gline-tables-only")
244   endif()
245   # Use -O1 even in debug mode, otherwise sanitizers slowdown is too large.
246   if (uppercase_CMAKE_BUILD_TYPE STREQUAL "DEBUG")
247     add_flag_if_supported("-O1")
248   endif()
249 endmacro()
250
251 # Turn on sanitizers if necessary.
252 if(LLVM_USE_SANITIZER)
253   if (LLVM_ON_UNIX)
254     if (LLVM_USE_SANITIZER STREQUAL "Address")
255       append_common_sanitizer_flags()
256       add_flag_or_print_warning("-fsanitize=address")
257     elseif (LLVM_USE_SANITIZER MATCHES "Memory(WithOrigins)?")
258       append_common_sanitizer_flags()
259       add_flag_or_print_warning("-fsanitize=memory")
260       if(LLVM_USE_SANITIZER STREQUAL "MemoryWithOrigins")
261         add_flag_or_print_warning("-fsanitize-memory-track-origins")
262       endif()
263     else()
264       message(WARNING "Unsupported value of LLVM_USE_SANITIZER: ${LLVM_USE_SANITIZER}")
265     endif()
266   else()
267     message(WARNING "LLVM_USE_SANITIZER is not supported on this platform.")
268   endif()
269 endif()
270
271 # Turn on -gsplit-dwarf if requested
272 if(LLVM_USE_SPLIT_DWARF)
273   add_llvm_definitions("-gsplit-dwarf")
274 endif()
275
276 add_llvm_definitions( -D__STDC_CONSTANT_MACROS )
277 add_llvm_definitions( -D__STDC_FORMAT_MACROS )
278 add_llvm_definitions( -D__STDC_LIMIT_MACROS )
279
280 # clang doesn't print colored diagnostics when invoked from Ninja
281 if (UNIX AND
282     CMAKE_CXX_COMPILER_ID STREQUAL "Clang" AND
283     CMAKE_GENERATOR STREQUAL "Ninja")
284   append("-fcolor-diagnostics" CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
285 endif()