1 # Copyright (C) 2020 The Khronos Group Inc.
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions
9 # Redistributions of source code must retain the above copyright
10 # notice, this list of conditions and the following disclaimer.
12 # Redistributions in binary form must reproduce the above
13 # copyright notice, this list of conditions and the following
14 # disclaimer in the documentation and/or other materials provided
15 # with the distribution.
17 # Neither the name of The Khronos Group Inc. nor the names of its
18 # contributors may be used to endorse or promote products derived
19 # from this software without specific prior written permission.
21 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 # COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 # POSSIBILITY OF SUCH DAMAGE.
37 # increase to 3.1 once all major distributions
38 # include a version of CMake >= 3.1
39 cmake_minimum_required(VERSION 2.8.12)
41 cmake_policy(SET CMP0048 NEW)
43 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
45 # Enable compile commands database
46 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
48 # Adhere to GNU filesystem layout conventions
49 include(GNUInstallDirs)
51 # Needed for CMAKE_DEPENDENT_OPTION macro
52 include(CMakeDependentOption)
54 option(BUILD_SHARED_LIBS "Build Shared Libraries" OFF)
55 option(BUILD_EXTERNAL "Build external dependencies in /External" ON)
63 if ("${CMAKE_BUILD_TYPE}" STREQUAL "")
64 # This logic inside SPIRV-Tools, which can upset build target dependencies
65 # if changed after targets are already defined. To prevent these issues,
66 # ensure CMAKE_BUILD_TYPE is assigned early and at the glslang root scope.
67 message(STATUS "No build type selected, default to Debug")
68 set(CMAKE_BUILD_TYPE "Debug")
71 option(SKIP_GLSLANG_INSTALL "Skip installation" ${SKIP_GLSLANG_INSTALL})
72 if(NOT ${SKIP_GLSLANG_INSTALL})
73 set(ENABLE_GLSLANG_INSTALL ON)
75 option(ENABLE_SPVREMAPPER "Enables building of SPVRemapper" ON)
77 option(ENABLE_GLSLANG_BINARIES "Builds glslangValidator and spirv-remap" ON)
79 option(ENABLE_GLSLANG_JS
80 "If using Emscripten, build glslang.js. Otherwise, builds a sample executable for binary-size testing." OFF)
81 CMAKE_DEPENDENT_OPTION(ENABLE_GLSLANG_WEBMIN
82 "Reduces glslang to minimum needed for web use"
83 OFF "ENABLE_GLSLANG_JS"
85 CMAKE_DEPENDENT_OPTION(ENABLE_GLSLANG_WEBMIN_DEVEL
86 "For ENABLE_GLSLANG_WEBMIN builds, enables compilation error messages"
87 OFF "ENABLE_GLSLANG_WEBMIN"
89 CMAKE_DEPENDENT_OPTION(ENABLE_EMSCRIPTEN_SINGLE_FILE
90 "If using Emscripten, enables SINGLE_FILE build"
91 OFF "ENABLE_GLSLANG_JS AND EMSCRIPTEN"
93 CMAKE_DEPENDENT_OPTION(ENABLE_EMSCRIPTEN_ENVIRONMENT_NODE
94 "If using Emscripten, builds to run on Node instead of Web"
95 OFF "ENABLE_GLSLANG_JS AND EMSCRIPTEN"
98 CMAKE_DEPENDENT_OPTION(ENABLE_HLSL
99 "Enables HLSL input support"
100 ON "NOT ENABLE_GLSLANG_WEBMIN"
103 option(ENABLE_RTTI "Enables RTTI" OFF)
104 option(ENABLE_EXCEPTIONS "Enables Exceptions" OFF)
105 option(ENABLE_OPT "Enables spirv-opt capability if present" ON)
106 option(ENABLE_PCH "Enables Precompiled header" ON)
107 option(ENABLE_CTEST "Enables testing" ON)
109 if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT AND WIN32)
110 set(CMAKE_INSTALL_PREFIX "install" CACHE STRING "..." FORCE)
113 option(USE_CCACHE "Use ccache" OFF)
115 find_program(CCACHE_FOUND ccache)
117 set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ccache)
126 add_definitions(-DENABLE_HLSL)
129 if(ENABLE_GLSLANG_WEBMIN)
130 add_definitions(-DGLSLANG_WEB)
131 if(ENABLE_GLSLANG_WEBMIN_DEVEL)
132 add_definitions(-DGLSLANG_WEB_DEVEL)
133 endif(ENABLE_GLSLANG_WEBMIN_DEVEL)
134 endif(ENABLE_GLSLANG_WEBMIN)
137 set(CMAKE_DEBUG_POSTFIX "d")
139 include(ChooseMSVCCRT.cmake)
141 add_definitions(-DGLSLANG_OSINCLUDE_WIN32)
143 add_definitions(-DGLSLANG_OSINCLUDE_UNIX)
145 message("unknown platform")
148 if(${CMAKE_CXX_COMPILER_ID} MATCHES "GNU")
149 add_compile_options(-Wall -Wmaybe-uninitialized -Wuninitialized -Wunused -Wunused-local-typedefs
150 -Wunused-parameter -Wunused-value -Wunused-variable -Wunused-but-set-parameter -Wunused-but-set-variable -fno-exceptions)
151 add_compile_options(-Wno-reorder) # disable this from -Wall, since it happens all over.
153 add_compile_options(-fno-rtti)
155 if(NOT ENABLE_EXCEPTIONS)
156 add_compile_options(-fno-exceptions)
158 if(NOT CMAKE_CXX_COMPILER_VERSION VERSION_LESS "9.0.0")
159 add_compile_options(-Werror=deprecated-copy)
162 if(NOT CMAKE_VERSION VERSION_LESS "3.13")
163 # Error if there's symbols that are not found at link time.
164 # add_link_options() was added in CMake 3.13 - if using an earlier
165 # version don't set this - it should be caught by presubmits anyway.
166 add_link_options("-Wl,--no-undefined")
168 elseif(${CMAKE_CXX_COMPILER_ID} MATCHES "Clang" AND NOT MSVC)
169 add_compile_options(-Wall -Wuninitialized -Wunused -Wunused-local-typedefs
170 -Wunused-parameter -Wunused-value -Wunused-variable)
171 add_compile_options(-Wno-reorder) # disable this from -Wall, since it happens all over.
173 add_compile_options(-fno-rtti)
175 if(NOT ENABLE_EXCEPTIONS)
176 add_compile_options(-fno-exceptions)
179 if(NOT CMAKE_VERSION VERSION_LESS "3.13")
180 # Error if there's symbols that are not found at link time.
181 # add_link_options() was added in CMake 3.13 - if using an earlier
182 # version don't set this - it should be caught by presubmits anyway.
183 add_link_options("-Wl,-undefined,error")
187 string(FIND "${CMAKE_CXX_FLAGS}" "/GR" MSVC_HAS_GR)
189 string(REGEX REPLACE /GR /GR- CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS})
191 add_compile_options(/GR-) # Disable RTTI
194 if(ENABLE_EXCEPTIONS)
195 add_compile_options(/EHsc) # Enable Exceptions
199 if(ENABLE_GLSLANG_JS)
201 add_compile_options(/Os /GR-)
203 add_compile_options(-Os -fno-rtti -fno-exceptions)
204 if(${CMAKE_CXX_COMPILER_ID} MATCHES "Clang" AND NOT MSVC)
205 add_compile_options(-Wno-unused-parameter)
206 add_compile_options(-Wno-unused-variable -Wno-unused-const-variable)
209 endif(ENABLE_GLSLANG_JS)
212 if(${CMAKE_VERSION} VERSION_LESS 3.1)
213 # CMake versions before 3.1 do not understand CMAKE_CXX_STANDARD
214 # remove this block once CMake >=3.1 has fixated in the ecosystem
215 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
217 set(CMAKE_CXX_STANDARD 11)
218 set(CMAKE_CXX_STANDARD_REQUIRED ON)
219 set(CMAKE_CXX_EXTENSIONS OFF)
222 function(glslang_set_link_args TARGET)
223 # For MinGW compiles, statically link against the GCC and C++ runtimes.
224 # This avoids the need to ship those runtimes as DLLs.
225 if(WIN32 AND ${CMAKE_CXX_COMPILER_ID} MATCHES "GNU")
226 set_target_properties(${TARGET} PROPERTIES
227 LINK_FLAGS "-static -static-libgcc -static-libstdc++")
229 endfunction(glslang_set_link_args)
231 # CMake needs to find the right version of python, right from the beginning,
232 # otherwise, it will find the wrong version and fail later
233 find_package(PythonInterp 3 REQUIRED)
235 # Root directory for build-time generated include files
236 set(GLSLANG_GENERATED_INCLUDEDIR "${CMAKE_BINARY_DIR}/include")
238 ################################################################################
239 # Build version information generation
240 ################################################################################
241 set(GLSLANG_CHANGES_FILE "${CMAKE_CURRENT_SOURCE_DIR}/CHANGES.md")
242 set(GLSLANG_BUILD_INFO_PY "${CMAKE_CURRENT_SOURCE_DIR}/build_info.py")
243 set(GLSLANG_BUILD_INFO_H_TMPL "${CMAKE_CURRENT_SOURCE_DIR}/build_info.h.tmpl")
244 set(GLSLANG_BUILD_INFO_H "${GLSLANG_GENERATED_INCLUDEDIR}/glslang/build_info.h")
246 # Command to build the build_info.h file
248 OUTPUT ${GLSLANG_BUILD_INFO_H}
249 COMMAND ${PYTHON_EXECUTABLE} "${GLSLANG_BUILD_INFO_PY}"
250 ${CMAKE_CURRENT_SOURCE_DIR}
251 "-i" ${GLSLANG_BUILD_INFO_H_TMPL}
252 "-o" ${GLSLANG_BUILD_INFO_H}
253 DEPENDS ${GLSLANG_BUILD_INFO_PY}
254 ${GLSLANG_CHANGES_FILE}
255 ${GLSLANG_BUILD_INFO_H_TMPL}
256 COMMENT "Generating ${GLSLANG_BUILD_INFO_H}")
258 # Target to build the build_info.h file
259 add_custom_target(glslang-build-info DEPENDS ${GLSLANG_BUILD_INFO_H})
261 # Populate the CMake GLSLANG_VERSION* variables with the build version
264 COMMAND ${PYTHON_EXECUTABLE} "${GLSLANG_BUILD_INFO_PY}"
265 ${CMAKE_CURRENT_SOURCE_DIR} "<major>.<minor>.<patch><-flavor>;<major>;<minor>;<patch>;<flavor>"
266 OUTPUT_VARIABLE "GLSLANG_VERSIONS"
267 OUTPUT_STRIP_TRAILING_WHITESPACE)
268 list(GET "GLSLANG_VERSIONS" 0 "GLSLANG_VERSION")
269 list(GET "GLSLANG_VERSIONS" 1 "GLSLANG_VERSION_MAJOR")
270 list(GET "GLSLANG_VERSIONS" 2 "GLSLANG_VERSION_MINOR")
271 list(GET "GLSLANG_VERSIONS" 3 "GLSLANG_VERSION_PATCH")
272 list(GET "GLSLANG_VERSIONS" 4 "GLSLANG_VERSION_FLAVOR")
273 configure_file(${GLSLANG_CHANGES_FILE} "${CMAKE_CURRENT_BINARY_DIR}/CHANGES.md") # Required to re-run cmake on version change
275 # glslang_add_build_info_dependency() adds the glslang-build-info dependency and
276 # generated include directories to target.
277 function(glslang_add_build_info_dependency target)
278 target_include_directories(${target} PUBLIC $<BUILD_INTERFACE:${GLSLANG_GENERATED_INCLUDEDIR}>)
279 add_dependencies(${target} glslang-build-info)
282 # glslang_default_to_hidden_visibility() makes the symbol visibility hidden by
283 # default for <target>.
284 function(glslang_default_to_hidden_visibility target)
286 target_compile_options(${target} PRIVATE "-fvisibility=hidden")
290 # glslang_only_export_explicit_symbols() makes the symbol visibility hidden by
291 # default for <target>, and sets the GLSLANG_IS_SHARED_LIBRARY define, and
292 # GLSLANG_EXPORTING to 1 when specifically building <target>.
293 function(glslang_only_export_explicit_symbols target)
294 glslang_default_to_hidden_visibility(${target})
295 if(BUILD_SHARED_LIBS)
296 target_compile_definitions(${target} PUBLIC "GLSLANG_IS_SHARED_LIBRARY=1")
298 target_compile_definitions(${target} PRIVATE "GLSLANG_EXPORTING=1")
303 # glslang_pch() adds precompiled header rules to <target> for the pre-compiled
304 # header file <pch>. As target_precompile_headers() was added in CMake 3.16,
305 # this is a no-op if called on earlier versions of CMake.
306 if(NOT CMAKE_VERSION VERSION_LESS "3.16")
307 function(glslang_pch target pch)
308 target_precompile_headers(${target} PRIVATE ${pch})
311 function(glslang_pch target pch)
313 message("Your CMake version is ${CMAKE_VERSION}. Update to at least 3.16 to enable precompiled headers to speed up incremental builds")
316 if(BUILD_EXTERNAL AND IS_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/External)
317 # We depend on these for later projects, so they should come first.
318 add_subdirectory(External)
321 if(NOT TARGET SPIRV-Tools-opt)
326 message(STATUS "optimizer enabled")
327 add_definitions(-DENABLE_OPT=1)
330 message(STATUS "spirv-tools not linked - illegal SPIRV may be generated for HLSL")
332 add_definitions(-DENABLE_OPT=0)
335 add_subdirectory(glslang)
336 add_subdirectory(OGLCompilersDLL)
337 if(ENABLE_GLSLANG_BINARIES)
338 add_subdirectory(StandAlone)
340 add_subdirectory(SPIRV)
342 add_subdirectory(hlsl)
345 add_subdirectory(gtests)
348 if(ENABLE_CTEST AND BUILD_TESTING)
349 # glslang-testsuite runs a bash script on Windows.
350 # Make sure to use '-o igncr' flag to ignore carriage returns (\r).
351 set(IGNORE_CR_FLAG "")
353 set(IGNORE_CR_FLAG -o igncr)
356 if (CMAKE_CONFIGURATION_TYPES)
357 set(RESULTS_PATH ${CMAKE_CURRENT_BINARY_DIR}/$<CONFIGURATION>/localResults)
358 set(VALIDATOR_PATH ${CMAKE_CURRENT_BINARY_DIR}/StandAlone/$<CONFIGURATION>/glslangValidator)
359 set(REMAP_PATH ${CMAKE_CURRENT_BINARY_DIR}/StandAlone/$<CONFIGURATION>/spirv-remap)
360 else(CMAKE_CONFIGURATION_TYPES)
361 set(RESULTS_PATH ${CMAKE_CURRENT_BINARY_DIR}/localResults)
362 set(VALIDATOR_PATH ${CMAKE_CURRENT_BINARY_DIR}/StandAlone/glslangValidator)
363 set(REMAP_PATH ${CMAKE_CURRENT_BINARY_DIR}/StandAlone/spirv-remap)
364 endif(CMAKE_CONFIGURATION_TYPES)
366 add_test(NAME glslang-testsuite
367 COMMAND bash ${IGNORE_CR_FLAG} runtests ${RESULTS_PATH} ${VALIDATOR_PATH} ${REMAP_PATH}
368 WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/Test/)