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(ENABLE_RTTI "Enables RTTI" OFF) 37option(SPIRV_ALLOW_TIMERS "Allow timers via clock_gettime on supported platforms" ON) 38 39if("${CMAKE_SYSTEM_NAME}" STREQUAL "Linux") 40 add_definitions(-DSPIRV_LINUX) 41 set(SPIRV_TIMER_ENABLED ${SPIRV_ALLOW_TIMERS}) 42elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Emscripten") 43 add_definitions(-DSPIRV_EMSCRIPTEN) 44elseif("${CMAKE_SYSTEM_NAME}" MATCHES "Windows") 45 add_definitions(-DSPIRV_WINDOWS) 46elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "CYGWIN") 47 add_definitions(-DSPIRV_WINDOWS) 48elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Darwin") 49 add_definitions(-DSPIRV_MAC) 50elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "iOS") 51 add_definitions(-DSPIRV_IOS) 52elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "tvOS") 53 add_definitions(-DSPIRV_TVOS) 54elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Android") 55 add_definitions(-DSPIRV_ANDROID) 56 set(SPIRV_TIMER_ENABLED ${SPIRV_ALLOW_TIMERS}) 57elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "FreeBSD") 58 add_definitions(-DSPIRV_FREEBSD) 59elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Fuchsia") 60 add_definitions(-DSPIRV_FUCHSIA) 61else() 62 message(FATAL_ERROR "Your platform '${CMAKE_SYSTEM_NAME}' is not supported!") 63endif() 64 65if (${SPIRV_TIMER_ENABLED}) 66 add_definitions(-DSPIRV_TIMER_ENABLED) 67endif() 68 69if ("${CMAKE_BUILD_TYPE}" STREQUAL "") 70 message(STATUS "No build type selected, default to Debug") 71 set(CMAKE_BUILD_TYPE "Debug") 72endif() 73 74option(SKIP_SPIRV_TOOLS_INSTALL "Skip installation" ${SKIP_SPIRV_TOOLS_INSTALL}) 75if(NOT ${SKIP_SPIRV_TOOLS_INSTALL}) 76 set(ENABLE_SPIRV_TOOLS_INSTALL ON) 77endif() 78 79option(SPIRV_BUILD_COMPRESSION "Build SPIR-V compressing codec" OFF) 80if(SPIRV_BUILD_COMPRESSION) 81 message(FATAL_ERROR "SPIR-V compression codec has been removed from SPIR-V tools. " 82 "Please remove SPIRV_BUILD_COMPRESSION from your build options.") 83endif(SPIRV_BUILD_COMPRESSION) 84 85option(SPIRV_BUILD_FUZZER "Build spirv-fuzz" OFF) 86 87set(SPIRV_LIB_FUZZING_ENGINE_LINK_OPTIONS "" CACHE STRING "Used by OSS-Fuzz to control, via link options, which fuzzing engine should be used") 88 89option(SPIRV_BUILD_LIBFUZZER_TARGETS "Build libFuzzer targets" OFF) 90 91option(SPIRV_WERROR "Enable error on warning" ON) 92if(("${CMAKE_CXX_COMPILER_ID}" MATCHES "GNU") OR (("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang") AND (NOT CMAKE_CXX_SIMULATE_ID STREQUAL "MSVC"))) 93 set(COMPILER_IS_LIKE_GNU TRUE) 94endif() 95if(${COMPILER_IS_LIKE_GNU}) 96 set(SPIRV_WARNINGS -Wall -Wextra -Wnon-virtual-dtor -Wno-missing-field-initializers) 97 98 if("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang") 99 set(SPIRV_WARNINGS ${SPIRV_WARNINGS} -Wno-self-assign) 100 endif() 101 102 option(SPIRV_WARN_EVERYTHING "Enable -Weverything" ${SPIRV_WARN_EVERYTHING}) 103 if(${SPIRV_WARN_EVERYTHING}) 104 if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang") 105 set(SPIRV_WARNINGS ${SPIRV_WARNINGS} 106 -Weverything -Wno-c++98-compat -Wno-c++98-compat-pedantic -Wno-padded) 107 elseif("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU") 108 set(SPIRV_WARNINGS ${SPIRV_WARNINGS} -Wpedantic -pedantic-errors) 109 else() 110 message(STATUS "Unknown compiler ${CMAKE_CXX_COMPILER_ID}, " 111 "so SPIRV_WARN_EVERYTHING has no effect") 112 endif() 113 endif() 114 115 if(${SPIRV_WERROR}) 116 set(SPIRV_WARNINGS ${SPIRV_WARNINGS} -Werror) 117 endif() 118elseif(MSVC) 119 set(SPIRV_WARNINGS -D_CRT_SECURE_NO_WARNINGS -D_SCL_SECURE_NO_WARNINGS /wd4800 /wd4819) 120 121 if(${SPIRV_WERROR}) 122 set(SPIRV_WARNINGS ${SPIRV_WARNINGS} /WX) 123 endif() 124endif() 125 126include_directories(${CMAKE_CURRENT_SOURCE_DIR}/) 127 128option(SPIRV_COLOR_TERMINAL "Enable color terminal output" ON) 129if(${SPIRV_COLOR_TERMINAL}) 130 add_definitions(-DSPIRV_COLOR_TERMINAL) 131endif() 132 133option(SPIRV_LOG_DEBUG "Enable excessive debug output" OFF) 134if(${SPIRV_LOG_DEBUG}) 135 add_definitions(-DSPIRV_LOG_DEBUG) 136endif() 137 138if (DEFINED SPIRV_TOOLS_EXTRA_DEFINITIONS) 139 add_definitions(${SPIRV_TOOLS_EXTRA_DEFINITIONS}) 140endif() 141 142# Library build setting definitions: 143# 144# * SPIRV_TOOLS_BUILD_STATIC - ON or OFF - Defaults to ON. 145# If enabled the following targets will be created: 146# ${SPIRV_TOOLS}-static - STATIC library. 147# Has full public symbol visibility. 148# ${SPIRV_TOOLS}-shared - SHARED library. 149# Has default-hidden symbol visibility. 150# ${SPIRV_TOOLS} - will alias to one of above, based on BUILD_SHARED_LIBS. 151# If disabled the following targets will be created: 152# ${SPIRV_TOOLS} - either STATIC or SHARED based on SPIRV_TOOLS_LIBRARY_TYPE. 153# Has full public symbol visibility. 154# ${SPIRV_TOOLS}-shared - SHARED library. 155# Has default-hidden symbol visibility. 156# 157# * SPIRV_TOOLS_LIBRARY_TYPE - SHARED or STATIC. 158# Specifies the library type used for building SPIRV-Tools libraries. 159# Defaults to SHARED when BUILD_SHARED_LIBS=1, otherwise STATIC. 160# 161# * SPIRV_TOOLS_FULL_VISIBILITY - "${SPIRV_TOOLS}-static" or "${SPIRV_TOOLS}" 162# Evaluates to the SPIRV_TOOLS target library name that has no hidden symbols. 163# This is used by internal targets for accessing symbols that are non-public. 164# Note this target provides no API stability guarantees. 165# 166# Ideally, all of these will go away - see https://github.com/KhronosGroup/SPIRV-Tools/issues/3909. 167option(ENABLE_EXCEPTIONS_ON_MSVC "Build SPIRV-TOOLS with c++ exceptions enabled in MSVC" ON) 168option(SPIRV_TOOLS_BUILD_STATIC "Build ${SPIRV_TOOLS}-static target. ${SPIRV_TOOLS} will alias to ${SPIRV_TOOLS}-static or ${SPIRV_TOOLS}-shared based on BUILD_SHARED_LIBS" ON) 169if(SPIRV_TOOLS_BUILD_STATIC) 170 set(SPIRV_TOOLS_FULL_VISIBILITY ${SPIRV_TOOLS}-static) 171 set(SPIRV_TOOLS_LIBRARY_TYPE "STATIC") 172else(SPIRV_TOOLS_BUILD_STATIC) 173 set(SPIRV_TOOLS_FULL_VISIBILITY ${SPIRV_TOOLS}) 174 if (NOT DEFINED SPIRV_TOOLS_LIBRARY_TYPE) 175 if(BUILD_SHARED_LIBS) 176 set(SPIRV_TOOLS_LIBRARY_TYPE "SHARED") 177 else() 178 set(SPIRV_TOOLS_LIBRARY_TYPE "STATIC") 179 endif() 180 endif() 181endif(SPIRV_TOOLS_BUILD_STATIC) 182 183function(spvtools_default_compile_options TARGET) 184 target_compile_options(${TARGET} PRIVATE ${SPIRV_WARNINGS}) 185 186 if (${COMPILER_IS_LIKE_GNU}) 187 target_compile_options(${TARGET} PRIVATE -std=c++11 -fno-exceptions) 188 target_compile_options(${TARGET} PRIVATE 189 -Wall -Wextra -Wno-long-long -Wshadow -Wundef -Wconversion 190 -Wno-sign-conversion) 191 192 if(NOT ENABLE_RTTI) 193 add_compile_options(-fno-rtti) 194 endif() 195 # For good call stacks in profiles, keep the frame pointers. 196 if(NOT "${SPIRV_PERF}" STREQUAL "") 197 target_compile_options(${TARGET} PRIVATE -fno-omit-frame-pointer) 198 endif() 199 if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang") 200 set(SPIRV_USE_SANITIZER "" CACHE STRING 201 "Use the clang sanitizer [address|memory|thread|...]") 202 if(NOT "${SPIRV_USE_SANITIZER}" STREQUAL "") 203 target_compile_options(${TARGET} PRIVATE 204 -fsanitize=${SPIRV_USE_SANITIZER}) 205 set_target_properties(${TARGET} PROPERTIES 206 LINK_FLAGS -fsanitize=${SPIRV_USE_SANITIZER}) 207 endif() 208 target_compile_options(${TARGET} PRIVATE 209 -ftemplate-depth=1024) 210 else() 211 target_compile_options(${TARGET} PRIVATE 212 -Wno-missing-field-initializers) 213 endif() 214 endif() 215 216 if (MSVC) 217 # Specify /EHs for exception handling. This makes using SPIRV-Tools as 218 # dependencies in other projects easier. 219 if(ENABLE_EXCEPTIONS_ON_MSVC) 220 target_compile_options(${TARGET} PRIVATE /EHs) 221 endif() 222 endif() 223 224 # For MinGW cross compile, statically link to the C++ runtime. 225 # But it still depends on MSVCRT.dll. 226 if (${CMAKE_SYSTEM_NAME} MATCHES "Windows") 227 if (${CMAKE_CXX_COMPILER_ID} MATCHES "GNU") 228 set_target_properties(${TARGET} PROPERTIES 229 LINK_FLAGS -static -static-libgcc -static-libstdc++) 230 endif() 231 endif() 232endfunction() 233 234if(NOT COMMAND find_host_package) 235 macro(find_host_package) 236 find_package(${ARGN}) 237 endmacro() 238endif() 239if(NOT COMMAND find_host_program) 240 macro(find_host_program) 241 find_program(${ARGN}) 242 endmacro() 243endif() 244 245# Tests require Python3 246find_host_package(PythonInterp 3 REQUIRED) 247 248# Check for symbol exports on Linux. 249# At the moment, this check will fail on the OSX build machines for the Android NDK. 250# It appears they don't have objdump. 251if("${CMAKE_SYSTEM_NAME}" STREQUAL "Linux") 252 macro(spvtools_check_symbol_exports TARGET) 253 if (NOT "${SPIRV_SKIP_TESTS}") 254 add_test(NAME spirv-tools-symbol-exports-${TARGET} 255 COMMAND ${PYTHON_EXECUTABLE} 256 ${spirv-tools_SOURCE_DIR}/utils/check_symbol_exports.py "$<TARGET_FILE:${TARGET}>") 257 endif() 258 endmacro() 259else() 260 macro(spvtools_check_symbol_exports TARGET) 261 if (NOT "${SPIRV_SKIP_TESTS}") 262 message("Skipping symbol exports test for ${TARGET}") 263 endif() 264 endmacro() 265endif() 266 267if(ENABLE_SPIRV_TOOLS_INSTALL) 268 if(WIN32) 269 macro(spvtools_config_package_dir TARGET PATH) 270 set(${PATH} ${TARGET}/cmake) 271 endmacro() 272 else() 273 macro(spvtools_config_package_dir TARGET PATH) 274 set(${PATH} ${CMAKE_INSTALL_LIBDIR}/cmake/${TARGET}) 275 endmacro() 276 endif() 277 278 macro(spvtools_generate_config_file TARGET) 279 file(WRITE ${CMAKE_BINARY_DIR}/${TARGET}Config.cmake 280 "include(CMakeFindDependencyMacro)\n" 281 "find_dependency(${SPIRV_TOOLS})\n" 282 "include(\${CMAKE_CURRENT_LIST_DIR}/${TARGET}Targets.cmake)\n" 283 "set(${TARGET}_LIBRARIES ${TARGET})\n" 284 "get_target_property(${TARGET}_INCLUDE_DIRS ${TARGET} INTERFACE_INCLUDE_DIRECTORIES)\n") 285 endmacro() 286endif() 287 288# Defaults to OFF if the user didn't set it. 289option(SPIRV_SKIP_EXECUTABLES 290 "Skip building the executable and tests along with the library" 291 ${SPIRV_SKIP_EXECUTABLES}) 292option(SPIRV_SKIP_TESTS 293 "Skip building tests along with the library" ${SPIRV_SKIP_TESTS}) 294if ("${SPIRV_SKIP_EXECUTABLES}") 295 set(SPIRV_SKIP_TESTS ON) 296endif() 297 298# Defaults to ON. The checks can be time consuming. 299# Turn off if they take too long. 300option(SPIRV_CHECK_CONTEXT "In a debug build, check if the IR context is in a valid state." ON) 301if (${SPIRV_CHECK_CONTEXT}) 302 add_compile_options($<$<CONFIG:Debug>:-DSPIRV_CHECK_CONTEXT>) 303endif() 304 305# Precompiled header macro. Parameters are source file list and filename for pch cpp file. 306macro(spvtools_pch SRCS PCHPREFIX) 307 if(MSVC AND CMAKE_GENERATOR MATCHES "^Visual Studio" AND NOT "${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang") 308 set(PCH_NAME "$(IntDir)\\${PCHPREFIX}.pch") 309 # make source files use/depend on PCH_NAME 310 set_source_files_properties(${${SRCS}} PROPERTIES COMPILE_FLAGS "/Yu${PCHPREFIX}.h /FI${PCHPREFIX}.h /Fp${PCH_NAME} /Zm300" OBJECT_DEPENDS "${PCH_NAME}") 311 # make PCHPREFIX.cpp file compile and generate PCH_NAME 312 set_source_files_properties("${PCHPREFIX}.cpp" PROPERTIES COMPILE_FLAGS "/Yc${PCHPREFIX}.h /Fp${PCH_NAME} /Zm300" OBJECT_OUTPUTS "${PCH_NAME}") 313 list(APPEND ${SRCS} "${PCHPREFIX}.cpp") 314 endif() 315endmacro(spvtools_pch) 316 317add_subdirectory(external) 318 319# Warning about extra semi-colons. 320# 321# This is not supported on all compilers/versions. so enabling only 322# for clang, since that works for all versions that our bots run. 323# 324# This is intentionally done after adding the external subdirectory, 325# so we don't enforce this flag on our dependencies, some of which do 326# not pass it. 327# 328# If the minimum version of CMake supported is updated to 3.0 or 329# later, then check_cxx_compiler_flag could be used instead. 330if("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang") 331 add_compile_options("-Wextra-semi") 332endif() 333 334add_subdirectory(source) 335add_subdirectory(tools) 336 337add_subdirectory(test) 338add_subdirectory(examples) 339 340if(ENABLE_SPIRV_TOOLS_INSTALL) 341 install( 342 FILES 343 ${CMAKE_CURRENT_SOURCE_DIR}/include/spirv-tools/libspirv.h 344 ${CMAKE_CURRENT_SOURCE_DIR}/include/spirv-tools/libspirv.hpp 345 ${CMAKE_CURRENT_SOURCE_DIR}/include/spirv-tools/optimizer.hpp 346 ${CMAKE_CURRENT_SOURCE_DIR}/include/spirv-tools/linker.hpp 347 ${CMAKE_CURRENT_SOURCE_DIR}/include/spirv-tools/instrument.hpp 348 DESTINATION 349 ${CMAKE_INSTALL_INCLUDEDIR}/spirv-tools/) 350endif(ENABLE_SPIRV_TOOLS_INSTALL) 351 352if (NOT "${SPIRV_SKIP_TESTS}") 353 add_test(NAME spirv-tools-copyrights 354 COMMAND ${PYTHON_EXECUTABLE} utils/check_copyright.py 355 WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) 356endif() 357 358set(SPIRV_LIBRARIES "-lSPIRV-Tools-opt -lSPIRV-Tools -lSPIRV-Tools-link") 359set(SPIRV_SHARED_LIBRARIES "-lSPIRV-Tools-shared") 360 361# Build pkg-config file 362# Use a first-class target so it's regenerated when relevant files are updated. 363add_custom_target(spirv-tools-pkg-config ALL 364 COMMAND ${CMAKE_COMMAND} 365 -DCHANGES_FILE=${CMAKE_CURRENT_SOURCE_DIR}/CHANGES 366 -DTEMPLATE_FILE=${CMAKE_CURRENT_SOURCE_DIR}/cmake/SPIRV-Tools.pc.in 367 -DOUT_FILE=${CMAKE_CURRENT_BINARY_DIR}/SPIRV-Tools.pc 368 -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX} 369 -DCMAKE_INSTALL_LIBDIR=${CMAKE_INSTALL_LIBDIR} 370 -DCMAKE_INSTALL_INCLUDEDIR=${CMAKE_INSTALL_INCLUDEDIR} 371 -DSPIRV_LIBRARIES=${SPIRV_LIBRARIES} 372 -P ${CMAKE_CURRENT_SOURCE_DIR}/cmake/write_pkg_config.cmake 373 DEPENDS "CHANGES" "cmake/SPIRV-Tools.pc.in" "cmake/write_pkg_config.cmake") 374add_custom_target(spirv-tools-shared-pkg-config ALL 375 COMMAND ${CMAKE_COMMAND} 376 -DCHANGES_FILE=${CMAKE_CURRENT_SOURCE_DIR}/CHANGES 377 -DTEMPLATE_FILE=${CMAKE_CURRENT_SOURCE_DIR}/cmake/SPIRV-Tools-shared.pc.in 378 -DOUT_FILE=${CMAKE_CURRENT_BINARY_DIR}/SPIRV-Tools-shared.pc 379 -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX} 380 -DCMAKE_INSTALL_LIBDIR=${CMAKE_INSTALL_LIBDIR} 381 -DCMAKE_INSTALL_INCLUDEDIR=${CMAKE_INSTALL_INCLUDEDIR} 382 -DSPIRV_SHARED_LIBRARIES=${SPIRV_SHARED_LIBRARIES} 383 -P ${CMAKE_CURRENT_SOURCE_DIR}/cmake/write_pkg_config.cmake 384 DEPENDS "CHANGES" "cmake/SPIRV-Tools-shared.pc.in" "cmake/write_pkg_config.cmake") 385 386# Install pkg-config file 387if (ENABLE_SPIRV_TOOLS_INSTALL) 388 install( 389 FILES 390 ${CMAKE_CURRENT_BINARY_DIR}/SPIRV-Tools.pc 391 ${CMAKE_CURRENT_BINARY_DIR}/SPIRV-Tools-shared.pc 392 DESTINATION 393 ${CMAKE_INSTALL_LIBDIR}/pkgconfig) 394endif() 395