1# Copyright (c) 2015-2016 The Khronos Group Inc. 2# 3# Licensed under the Apache License, Version 2.0 (the "License"); 4# you may not use this file except in compliance with the License. 5# You may obtain a copy of the License at 6# 7# http://www.apache.org/licenses/LICENSE-2.0 8# 9# Unless required by applicable law or agreed to in writing, software 10# distributed under the License is distributed on an "AS IS" BASIS, 11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12# See the License for the specific language governing permissions and 13# limitations under the License. 14 15cmake_minimum_required(VERSION 2.8.12) 16if (POLICY CMP0048) 17 cmake_policy(SET CMP0048 NEW) 18endif() 19if (POLICY CMP0054) 20 # Avoid dereferencing variables or interpret keywords that have been 21 # quoted or bracketed. 22 # https://cmake.org/cmake/help/v3.1/policy/CMP0054.html 23 cmake_policy(SET CMP0054 NEW) 24endif() 25set_property(GLOBAL PROPERTY USE_FOLDERS ON) 26 27project(spirv-tools) 28enable_testing() 29set(SPIRV_TOOLS "SPIRV-Tools") 30 31include(GNUInstallDirs) 32 33set(CMAKE_POSITION_INDEPENDENT_CODE ON) 34set(CMAKE_CXX_STANDARD 11) 35 36option(SPIRV_ALLOW_TIMERS "Allow timers via clock_gettime on supported platforms" ON) 37 38if("${CMAKE_SYSTEM_NAME}" STREQUAL "Linux") 39 add_definitions(-DSPIRV_LINUX) 40 set(SPIRV_TIMER_ENABLED ${SPIRV_ALLOW_TIMERS}) 41elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Emscripten") 42 add_definitions(-DSPIRV_EMSCRIPTEN) 43elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Windows") 44 add_definitions(-DSPIRV_WINDOWS) 45elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "CYGWIN") 46 add_definitions(-DSPIRV_WINDOWS) 47elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Darwin") 48 add_definitions(-DSPIRV_MAC) 49elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "iOS") 50 add_definitions(-DSPIRV_IOS) 51elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Android") 52 add_definitions(-DSPIRV_ANDROID) 53 set(SPIRV_TIMER_ENABLED ${SPIRV_ALLOW_TIMERS}) 54elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "FreeBSD") 55 add_definitions(-DSPIRV_FREEBSD) 56elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Fuchsia") 57 add_definitions(-DSPIRV_FUCHSIA) 58else() 59 message(FATAL_ERROR "Your platform '${CMAKE_SYSTEM_NAME}' is not supported!") 60endif() 61 62if (${SPIRV_TIMER_ENABLED}) 63 add_definitions(-DSPIRV_TIMER_ENABLED) 64endif() 65 66if ("${CMAKE_BUILD_TYPE}" STREQUAL "") 67 message(STATUS "No build type selected, default to Debug") 68 set(CMAKE_BUILD_TYPE "Debug") 69endif() 70 71option(SKIP_SPIRV_TOOLS_INSTALL "Skip installation" ${SKIP_SPIRV_TOOLS_INSTALL}) 72if(NOT ${SKIP_SPIRV_TOOLS_INSTALL}) 73 set(ENABLE_SPIRV_TOOLS_INSTALL ON) 74endif() 75 76option(SPIRV_BUILD_COMPRESSION "Build SPIR-V compressing codec" OFF) 77if(SPIRV_BUILD_COMPRESSION) 78 message(FATAL_ERROR "SPIR-V compression codec has been removed from SPIR-V tools. " 79 "Please remove SPIRV_BUILD_COMPRESSION from your build options.") 80endif(SPIRV_BUILD_COMPRESSION) 81 82option(SPIRV_WERROR "Enable error on warning" ON) 83if(("${CMAKE_CXX_COMPILER_ID}" MATCHES "GNU") OR (("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang") AND (NOT CMAKE_CXX_SIMULATE_ID STREQUAL "MSVC"))) 84 set(COMPILER_IS_LIKE_GNU TRUE) 85endif() 86if(${COMPILER_IS_LIKE_GNU}) 87 set(SPIRV_WARNINGS -Wall -Wextra -Wnon-virtual-dtor -Wno-missing-field-initializers) 88 89 if("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang") 90 set(SPIRV_WARNINGS ${SPIRV_WARNINGS} -Wno-self-assign) 91 endif() 92 93 option(SPIRV_WARN_EVERYTHING "Enable -Weverything" ${SPIRV_WARN_EVERYTHING}) 94 if(${SPIRV_WARN_EVERYTHING}) 95 if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang") 96 set(SPIRV_WARNINGS ${SPIRV_WARNINGS} 97 -Weverything -Wno-c++98-compat -Wno-c++98-compat-pedantic -Wno-padded) 98 elseif("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU") 99 set(SPIRV_WARNINGS ${SPIRV_WARNINGS} -Wpedantic -pedantic-errors) 100 else() 101 message(STATUS "Unknown compiler ${CMAKE_CXX_COMPILER_ID}, " 102 "so SPIRV_WARN_EVERYTHING has no effect") 103 endif() 104 endif() 105 106 if(${SPIRV_WERROR}) 107 set(SPIRV_WARNINGS ${SPIRV_WARNINGS} -Werror) 108 endif() 109elseif(MSVC) 110 set(SPIRV_WARNINGS -D_CRT_SECURE_NO_WARNINGS -D_SCL_SECURE_NO_WARNINGS /wd4800) 111 112 if(${SPIRV_WERROR}) 113 set(SPIRV_WARNINGS ${SPIRV_WARNINGS} /WX) 114 endif() 115endif() 116 117include_directories(${CMAKE_CURRENT_SOURCE_DIR}/) 118 119option(SPIRV_COLOR_TERMINAL "Enable color terminal output" ON) 120if(${SPIRV_COLOR_TERMINAL}) 121 add_definitions(-DSPIRV_COLOR_TERMINAL) 122endif() 123 124option(SPIRV_LOG_DEBUG "Enable excessive debug output" OFF) 125if(${SPIRV_LOG_DEBUG}) 126 add_definitions(-DSPIRV_LOG_DEBUG) 127endif() 128 129if (DEFINED SPIRV_TOOLS_EXTRA_DEFINITIONS) 130 add_definitions(${SPIRV_TOOLS_EXTRA_DEFINITIONS}) 131endif() 132 133function(spvtools_default_compile_options TARGET) 134 target_compile_options(${TARGET} PRIVATE ${SPIRV_WARNINGS}) 135 136 if (${COMPILER_IS_LIKE_GNU}) 137 target_compile_options(${TARGET} PRIVATE 138 -std=c++11 -fno-exceptions -fno-rtti) 139 target_compile_options(${TARGET} PRIVATE 140 -Wall -Wextra -Wno-long-long -Wshadow -Wundef -Wconversion 141 -Wno-sign-conversion) 142 # For good call stacks in profiles, keep the frame pointers. 143 if(NOT "${SPIRV_PERF}" STREQUAL "") 144 target_compile_options(${TARGET} PRIVATE -fno-omit-frame-pointer) 145 endif() 146 if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang") 147 set(SPIRV_USE_SANITIZER "" CACHE STRING 148 "Use the clang sanitizer [address|memory|thread|...]") 149 if(NOT "${SPIRV_USE_SANITIZER}" STREQUAL "") 150 target_compile_options(${TARGET} PRIVATE 151 -fsanitize=${SPIRV_USE_SANITIZER}) 152 set_target_properties(${TARGET} PROPERTIES 153 LINK_FLAGS -fsanitize=${SPIRV_USE_SANITIZER}) 154 endif() 155 target_compile_options(${TARGET} PRIVATE 156 -ftemplate-depth=1024) 157 else() 158 target_compile_options(${TARGET} PRIVATE 159 -Wno-missing-field-initializers) 160 endif() 161 endif() 162 163 if (MSVC) 164 # Specify /EHs for exception handling. This makes using SPIRV-Tools as 165 # dependencies in other projects easier. 166 target_compile_options(${TARGET} PRIVATE /EHs) 167 endif() 168 169 # For MinGW cross compile, statically link to the C++ runtime. 170 # But it still depends on MSVCRT.dll. 171 if (${CMAKE_SYSTEM_NAME} MATCHES "Windows") 172 if (${CMAKE_CXX_COMPILER_ID} MATCHES "GNU") 173 set_target_properties(${TARGET} PROPERTIES 174 LINK_FLAGS -static -static-libgcc -static-libstdc++) 175 endif() 176 endif() 177endfunction() 178 179if(NOT COMMAND find_host_package) 180 macro(find_host_package) 181 find_package(${ARGN}) 182 endmacro() 183endif() 184if(NOT COMMAND find_host_program) 185 macro(find_host_program) 186 find_program(${ARGN}) 187 endmacro() 188endif() 189 190# Tests require Python3 191find_host_package(PythonInterp 3 REQUIRED) 192 193# Check for symbol exports on Linux. 194# At the moment, this check will fail on the OSX build machines for the Android NDK. 195# It appears they don't have objdump. 196if("${CMAKE_SYSTEM_NAME}" STREQUAL "Linux") 197 macro(spvtools_check_symbol_exports TARGET) 198 if (NOT "${SPIRV_SKIP_TESTS}") 199 add_test(NAME spirv-tools-symbol-exports-${TARGET} 200 COMMAND ${PYTHON_EXECUTABLE} 201 ${spirv-tools_SOURCE_DIR}/utils/check_symbol_exports.py "$<TARGET_FILE:${TARGET}>") 202 endif() 203 endmacro() 204else() 205 macro(spvtools_check_symbol_exports TARGET) 206 if (NOT "${SPIRV_SKIP_TESTS}") 207 message("Skipping symbol exports test for ${TARGET}") 208 endif() 209 endmacro() 210endif() 211 212if(ENABLE_SPIRV_TOOLS_INSTALL) 213 if(WIN32) 214 macro(spvtools_config_package_dir TARGET PATH) 215 set(${PATH} ${TARGET}/cmake) 216 endmacro() 217 else() 218 macro(spvtools_config_package_dir TARGET PATH) 219 set(${PATH} ${CMAKE_INSTALL_LIBDIR}/cmake/${TARGET}) 220 endmacro() 221 endif() 222 223 macro(spvtools_generate_config_file TARGET) 224 file(WRITE ${CMAKE_BINARY_DIR}/${TARGET}Config.cmake 225 "include(CMakeFindDependencyMacro)\n" 226 "find_dependency(${SPIRV_TOOLS})\n" 227 "include(\${CMAKE_CURRENT_LIST_DIR}/${TARGET}Targets.cmake)\n" 228 "set(${TARGET}_LIBRARIES ${TARGET})\n" 229 "get_target_property(${TARGET}_INCLUDE_DIRS ${TARGET} INTERFACE_INCLUDE_DIRECTORIES)\n") 230 endmacro() 231endif() 232 233# Defaults to OFF if the user didn't set it. 234option(SPIRV_SKIP_EXECUTABLES 235 "Skip building the executable and tests along with the library" 236 ${SPIRV_SKIP_EXECUTABLES}) 237option(SPIRV_SKIP_TESTS 238 "Skip building tests along with the library" ${SPIRV_SKIP_TESTS}) 239if ("${SPIRV_SKIP_EXECUTABLES}") 240 set(SPIRV_SKIP_TESTS ON) 241endif() 242 243# Defaults to ON. The checks can be time consuming. 244# Turn off if they take too long. 245option(SPIRV_CHECK_CONTEXT "In a debug build, check if the IR context is in a valid state." ON) 246if (${SPIRV_CHECK_CONTEXT}) 247 add_definitions(-DSPIRV_CHECK_CONTEXT) 248endif() 249 250# Precompiled header macro. Parameters are source file list and filename for pch cpp file. 251macro(spvtools_pch SRCS PCHPREFIX) 252 if(MSVC AND CMAKE_GENERATOR MATCHES "^Visual Studio" AND NOT "${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang") 253 set(PCH_NAME "$(IntDir)\\${PCHPREFIX}.pch") 254 # make source files use/depend on PCH_NAME 255 set_source_files_properties(${${SRCS}} PROPERTIES COMPILE_FLAGS "/Yu${PCHPREFIX}.h /FI${PCHPREFIX}.h /Fp${PCH_NAME} /Zm300" OBJECT_DEPENDS "${PCH_NAME}") 256 # make PCHPREFIX.cpp file compile and generate PCH_NAME 257 set_source_files_properties("${PCHPREFIX}.cpp" PROPERTIES COMPILE_FLAGS "/Yc${PCHPREFIX}.h /Fp${PCH_NAME} /Zm300" OBJECT_OUTPUTS "${PCH_NAME}") 258 list(APPEND ${SRCS} "${PCHPREFIX}.cpp") 259 endif() 260endmacro(spvtools_pch) 261 262add_subdirectory(external) 263 264# Warning about extra semi-colons. 265# 266# This is not supported on all compilers/versions. so enabling only 267# for clang, since that works for all versions that our bots run. 268# 269# This is intentionally done after adding the external subdirectory, 270# so we don't enforce this flag on our dependencies, some of which do 271# not pass it. 272# 273# If the minimum version of CMake supported is updated to 3.0 or 274# later, then check_cxx_compiler_flag could be used instead. 275if("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang") 276 add_compile_options("-Wextra-semi") 277endif() 278 279add_subdirectory(source) 280add_subdirectory(tools) 281 282add_subdirectory(test) 283add_subdirectory(examples) 284 285if(ENABLE_SPIRV_TOOLS_INSTALL) 286 install( 287 FILES 288 ${CMAKE_CURRENT_SOURCE_DIR}/include/spirv-tools/libspirv.h 289 ${CMAKE_CURRENT_SOURCE_DIR}/include/spirv-tools/libspirv.hpp 290 ${CMAKE_CURRENT_SOURCE_DIR}/include/spirv-tools/optimizer.hpp 291 ${CMAKE_CURRENT_SOURCE_DIR}/include/spirv-tools/linker.hpp 292 ${CMAKE_CURRENT_SOURCE_DIR}/include/spirv-tools/instrument.hpp 293 DESTINATION 294 ${CMAKE_INSTALL_INCLUDEDIR}/spirv-tools/) 295endif(ENABLE_SPIRV_TOOLS_INSTALL) 296 297if (NOT "${SPIRV_SKIP_TESTS}") 298 add_test(NAME spirv-tools-copyrights 299 COMMAND ${PYTHON_EXECUTABLE} utils/check_copyright.py 300 WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) 301endif() 302 303set(SPIRV_LIBRARIES "-lSPIRV-Tools-opt -lSPIRV-Tools -lSPIRV-Tools-link") 304set(SPIRV_SHARED_LIBRARIES "-lSPIRV-Tools-shared") 305 306# Build pkg-config file 307# Use a first-class target so it's regenerated when relevant files are updated. 308add_custom_target(spirv-tools-pkg-config ALL 309 COMMAND ${CMAKE_COMMAND} 310 -DCHANGES_FILE=${CMAKE_CURRENT_SOURCE_DIR}/CHANGES 311 -DTEMPLATE_FILE=${CMAKE_CURRENT_SOURCE_DIR}/cmake/SPIRV-Tools.pc.in 312 -DOUT_FILE=${CMAKE_CURRENT_BINARY_DIR}/SPIRV-Tools.pc 313 -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX} 314 -DCMAKE_INSTALL_LIBDIR=${CMAKE_INSTALL_LIBDIR} 315 -DCMAKE_INSTALL_INCLUDEDIR=${CMAKE_INSTALL_INCLUDEDIR} 316 -DSPIRV_LIBRARIES=${SPIRV_LIBRARIES} 317 -P ${CMAKE_CURRENT_SOURCE_DIR}/cmake/write_pkg_config.cmake 318 DEPENDS "CHANGES" "cmake/SPIRV-Tools.pc.in" "cmake/write_pkg_config.cmake") 319add_custom_target(spirv-tools-shared-pkg-config ALL 320 COMMAND ${CMAKE_COMMAND} 321 -DCHANGES_FILE=${CMAKE_CURRENT_SOURCE_DIR}/CHANGES 322 -DTEMPLATE_FILE=${CMAKE_CURRENT_SOURCE_DIR}/cmake/SPIRV-Tools-shared.pc.in 323 -DOUT_FILE=${CMAKE_CURRENT_BINARY_DIR}/SPIRV-Tools-shared.pc 324 -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX} 325 -DCMAKE_INSTALL_LIBDIR=${CMAKE_INSTALL_LIBDIR} 326 -DCMAKE_INSTALL_INCLUDEDIR=${CMAKE_INSTALL_INCLUDEDIR} 327 -DSPIRV_SHARED_LIBRARIES=${SPIRV_SHARED_LIBRARIES} 328 -P ${CMAKE_CURRENT_SOURCE_DIR}/cmake/write_pkg_config.cmake 329 DEPENDS "CHANGES" "cmake/SPIRV-Tools-shared.pc.in" "cmake/write_pkg_config.cmake") 330 331# Install pkg-config file 332if (ENABLE_SPIRV_TOOLS_INSTALL) 333 install( 334 FILES 335 ${CMAKE_CURRENT_BINARY_DIR}/SPIRV-Tools.pc 336 ${CMAKE_CURRENT_BINARY_DIR}/SPIRV-Tools-shared.pc 337 DESTINATION 338 ${CMAKE_INSTALL_LIBDIR}/pkgconfig) 339endif() 340