1 # Copyright (c) 2015-2016 The Khronos Group Inc.
3 # Permission is hereby granted, free of charge, to any person obtaining a
4 # copy of this software and/or associated documentation files (the
5 # "Materials"), to deal in the Materials without restriction, including
6 # without limitation the rights to use, copy, modify, merge, publish,
7 # distribute, sublicense, and/or sell copies of the Materials, and to
8 # permit persons to whom the Materials are furnished to do so, subject to
9 # the following conditions:
11 # The above copyright notice and this permission notice shall be included
12 # in all copies or substantial portions of the Materials.
14 # MODIFICATIONS TO THIS FILE MAY MEAN IT NO LONGER ACCURATELY REFLECTS
15 # KHRONOS STANDARDS. THE UNMODIFIED, NORMATIVE VERSIONS OF KHRONOS
16 # SPECIFICATIONS AND HEADER INFORMATION ARE LOCATED AT
17 # https://www.khronos.org/registry/
19 # THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22 # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
23 # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
24 # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
25 # MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
27 cmake_minimum_required(VERSION 2.8.12)
30 set(SPIRV_TOOLS "SPIRV-Tools")
32 if("${CMAKE_SYSTEM_NAME}" STREQUAL "Linux")
33 add_definitions(-DSPIRV_LINUX)
34 elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Windows")
35 add_definitions(-DSPIRV_WINDOWS)
36 elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Darwin")
37 add_definitions(-DSPIRV_MAC)
39 message(FATAL_ERROR "Your platform '${CMAKE_SYSTEM_NAME}' is not supported!")
42 if ("${CMAKE_BUILD_TYPE}" STREQUAL "")
43 message(STATUS "No build type selected, default to Debug")
44 set(CMAKE_BUILD_TYPE "Debug")
47 option(SPIRV_WERROR "Enable error on warning" ON)
48 if((${CMAKE_CXX_COMPILER_ID} MATCHES "GNU") OR (${CMAKE_CXX_COMPILER_ID} MATCHES "Clang"))
49 set(COMPILER_IS_LIKE_GNU TRUE)
51 if(${COMPILER_IS_LIKE_GNU})
52 set(SPIRV_WARNINGS -Wall -Wextra -Wno-missing-field-initializers)
54 option(SPIRV_WARN_EVERYTHING "Enable -Weverything" ${SPIRV_WARN_EVERYTHING})
55 if(${SPIRV_WARN_EVERYTHING})
56 if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
57 set(SPIRV_WARNINGS ${SPIRV_WARNINGS}
58 -Weverything -Wno-c++98-compat -Wno-c++98-compat-pedantic -Wno-padded)
59 elseif("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
60 set(SPIRV_WARNINGS ${SPIRV_WARNINGS} -Wpedantic -pedantic-errors)
62 message(STATUS "Unknown compiler ${CMAKE_CXX_COMPILER_ID}, "
63 "so SPIRV_WARN_EVERYTHING has no effect")
68 set(SPIRV_WARNINGS ${SPIRV_WARNINGS} -Werror)
71 set(SPIRV_WARNINGS -D_CRT_SECURE_NO_WARNINGS /wd4800)
74 set(SPIRV_WARNINGS ${SPIRV_WARNINGS} /WX)
78 option(SPIRV_COLOR_TERMINAL "Enable color terminal output" ON)
79 if(${SPIRV_COLOR_TERMINAL})
80 add_definitions(-DSPIRV_COLOR_TERMINAL)
83 function(spvtools_default_compile_options TARGET)
84 target_compile_options(${TARGET} PRIVATE ${SPIRV_WARNINGS})
86 if (${COMPILER_IS_LIKE_GNU})
87 target_compile_options(${TARGET} PRIVATE
88 -std=c++11 -fno-exceptions -fno-rtti)
89 target_compile_options(${TARGET} PRIVATE
90 -Wall -Wextra -Wno-long-long -Wshadow -Wundef -Wconversion
92 # For good call stacks in profiles, keep the frame pointers.
93 if(NOT "${SPIRV_PERF}" STREQUAL "")
94 target_compile_options(${TARGET} PRIVATE -fno-omit-frame-pointer)
96 if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
97 set(SPIRV_USE_SANITIZER "" CACHE STRING
98 "Use the clang sanitizer [address|memory|thread|...]")
99 if(NOT "${SPIRV_USE_SANITIZER}" STREQUAL "")
100 target_compile_options(${TARGET} PRIVATE
101 -fsanitize=${SPIRV_USE_SANITIZER})
104 target_compile_options(${TARGET} PRIVATE
105 -Wno-missing-field-initializers)
109 # For MinGW cross compile, statically link to the C++ runtime.
110 # But it still depends on MSVCRT.dll.
111 if (${CMAKE_SYSTEM_NAME} MATCHES "Windows")
112 if (${CMAKE_CXX_COMPILER_ID} MATCHES "GNU")
113 set_target_properties(${TARGET} PROPERTIES LINK_FLAGS
114 -static -static-libgcc -static-libstdc++)
119 if(NOT COMMAND find_host_package)
120 macro(find_host_package)
121 find_package(${ARGN})
124 if(NOT COMMAND find_host_program)
125 macro(find_host_program)
126 find_program(${ARGN})
130 find_host_package(PythonInterp)
132 add_custom_target(spirv-tools-build-version
134 ${CMAKE_CURRENT_SOURCE_DIR}/utils/update_build_version.py
135 ${spirv-tools_SOURCE_DIR}
136 COMMENT "Update build-version.inc in the Spirv-tools build directory (if necessary).")
139 ${CMAKE_CURRENT_SOURCE_DIR}/include/spirv-tools/libspirv.h
140 ${CMAKE_CURRENT_SOURCE_DIR}/include/spirv/spirv.h
141 ${CMAKE_CURRENT_SOURCE_DIR}/include/spirv/GLSL.std.450.h
142 ${CMAKE_CURRENT_SOURCE_DIR}/include/spirv/OpenCL.std.h
143 ${CMAKE_CURRENT_SOURCE_DIR}/source/util/bitutils.h
144 ${CMAKE_CURRENT_SOURCE_DIR}/source/util/hex_float.h
145 ${CMAKE_CURRENT_SOURCE_DIR}/source/assembly_grammar.h
146 ${CMAKE_CURRENT_SOURCE_DIR}/source/binary.h
147 ${CMAKE_CURRENT_SOURCE_DIR}/source/diagnostic.h
148 ${CMAKE_CURRENT_SOURCE_DIR}/source/ext_inst.h
149 ${CMAKE_CURRENT_SOURCE_DIR}/source/instruction.h
150 ${CMAKE_CURRENT_SOURCE_DIR}/source/opcode.h
151 ${CMAKE_CURRENT_SOURCE_DIR}/source/operand.h
152 ${CMAKE_CURRENT_SOURCE_DIR}/source/print.h
153 ${CMAKE_CURRENT_SOURCE_DIR}/source/spirv_constant.h
154 ${CMAKE_CURRENT_SOURCE_DIR}/source/spirv_definition.h
155 ${CMAKE_CURRENT_SOURCE_DIR}/source/spirv_endian.h
156 ${CMAKE_CURRENT_SOURCE_DIR}/source/table.h
157 ${CMAKE_CURRENT_SOURCE_DIR}/source/text.h
158 ${CMAKE_CURRENT_SOURCE_DIR}/source/text_handler.h
159 ${CMAKE_CURRENT_SOURCE_DIR}/source/validate.h
160 ${CMAKE_CURRENT_SOURCE_DIR}/source/assembly_grammar.cpp
161 ${CMAKE_CURRENT_SOURCE_DIR}/source/binary.cpp
162 ${CMAKE_CURRENT_SOURCE_DIR}/source/disassemble.cpp
163 ${CMAKE_CURRENT_SOURCE_DIR}/source/diagnostic.cpp
164 ${CMAKE_CURRENT_SOURCE_DIR}/source/ext_inst.cpp
165 ${CMAKE_CURRENT_SOURCE_DIR}/source/instruction.cpp
166 ${CMAKE_CURRENT_SOURCE_DIR}/source/opcode.cpp
167 ${CMAKE_CURRENT_SOURCE_DIR}/source/operand.cpp
168 ${CMAKE_CURRENT_SOURCE_DIR}/source/print.cpp
169 ${CMAKE_CURRENT_SOURCE_DIR}/source/spirv_endian.cpp
170 ${CMAKE_CURRENT_SOURCE_DIR}/source/table.cpp
171 ${CMAKE_CURRENT_SOURCE_DIR}/source/text.cpp
172 ${CMAKE_CURRENT_SOURCE_DIR}/source/text_handler.cpp
173 ${CMAKE_CURRENT_SOURCE_DIR}/source/validate.cpp
174 ${CMAKE_CURRENT_SOURCE_DIR}/source/validate_cfg.cpp
175 ${CMAKE_CURRENT_SOURCE_DIR}/source/validate_id.cpp
176 ${CMAKE_CURRENT_SOURCE_DIR}/source/validate_instruction.cpp
177 ${CMAKE_CURRENT_SOURCE_DIR}/source/validate_layout.cpp
178 ${CMAKE_CURRENT_SOURCE_DIR}/source/validate_ssa.cpp
179 ${CMAKE_CURRENT_SOURCE_DIR}/source/validate_types.cpp)
181 add_library(${SPIRV_TOOLS} ${SPIRV_SOURCES})
182 spvtools_default_compile_options(${SPIRV_TOOLS})
183 target_include_directories(${SPIRV_TOOLS} PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)
185 # Defaults to OFF if the user didn't set it.
186 option(SPIRV_SKIP_EXECUTABLES
187 "Skip building the executable and tests along with the library"
188 ${SPIRV_SKIP_EXECUTABLES})
189 set(SPIRV_INSTALL_TARGETS ${SPIRV_TOOLS})
190 if (NOT ${SPIRV_SKIP_EXECUTABLES})
191 list(APPEND SPIRV_INSTALL_TARGETS spirv-as spirv-dis spirv-val)
193 add_executable(spirv-as ${CMAKE_CURRENT_SOURCE_DIR}/tools/as/as.cpp)
194 spvtools_default_compile_options(spirv-as)
195 target_link_libraries(spirv-as PRIVATE ${SPIRV_TOOLS})
196 target_include_directories(spirv-as PRIVATE ${CMAKE_CURRENT_BINARY_DIR})
197 add_dependencies(${SPIRV_TOOLS} spirv-tools-build-version)
200 add_executable(spirv-dis ${CMAKE_CURRENT_SOURCE_DIR}/tools/dis/dis.cpp)
201 spvtools_default_compile_options(spirv-dis)
202 target_link_libraries(spirv-dis PRIVATE ${SPIRV_TOOLS})
203 target_include_directories(spirv-dis PRIVATE ${CMAKE_CURRENT_BINARY_DIR})
204 add_dependencies(${SPIRV_TOOLS} spirv-tools-build-version)
206 add_executable(spirv-val ${CMAKE_CURRENT_SOURCE_DIR}/tools/val/val.cpp)
207 spvtools_default_compile_options(spirv-val)
208 target_link_libraries(spirv-val PRIVATE ${SPIRV_TOOLS})
209 target_include_directories(spirv-val PRIVATE ${CMAKE_CURRENT_BINARY_DIR})
210 add_dependencies(${SPIRV_TOOLS} spirv-tools-build-version)
212 # Find gmock if we can. If it's not already configured, then try finding
213 # it in external/googletest
215 message(STATUS "Google Mock already configured")
217 set(GMOCK_DIR ${CMAKE_CURRENT_SOURCE_DIR}/external/googletest/googlemock)
218 if(EXISTS ${GMOCK_DIR})
220 option(gtest_force_shared_crt
221 "Use shared (DLL) run-time lib even when Google Test is built as static lib."
224 add_subdirectory(${GMOCK_DIR})
228 message(STATUS "Found Google Mock, building tests.")
231 ${CMAKE_CURRENT_SOURCE_DIR}/test/TestFixture.h
232 ${CMAKE_CURRENT_SOURCE_DIR}/test/UnitSPIRV.h
234 ${CMAKE_CURRENT_SOURCE_DIR}/test/AssemblyContext.cpp
235 ${CMAKE_CURRENT_SOURCE_DIR}/test/AssemblyFormat.cpp
236 ${CMAKE_CURRENT_SOURCE_DIR}/test/BinaryDestroy.cpp
237 ${CMAKE_CURRENT_SOURCE_DIR}/test/BinaryEndianness.cpp
238 ${CMAKE_CURRENT_SOURCE_DIR}/test/BinaryHeaderGet.cpp
239 ${CMAKE_CURRENT_SOURCE_DIR}/test/BinaryParse.cpp
240 ${CMAKE_CURRENT_SOURCE_DIR}/test/BinaryToText.cpp
241 ${CMAKE_CURRENT_SOURCE_DIR}/test/BinaryToText.Literal.cpp
242 ${CMAKE_CURRENT_SOURCE_DIR}/test/Comment.cpp
243 ${CMAKE_CURRENT_SOURCE_DIR}/test/DiagnosticDestroy.cpp
244 ${CMAKE_CURRENT_SOURCE_DIR}/test/DiagnosticPrint.cpp
245 ${CMAKE_CURRENT_SOURCE_DIR}/test/DiagnosticStream.cpp
246 ${CMAKE_CURRENT_SOURCE_DIR}/test/ExtInstGLSLstd450.cpp
247 ${CMAKE_CURRENT_SOURCE_DIR}/test/ExtInst.OpenCL.std.cpp
248 ${CMAKE_CURRENT_SOURCE_DIR}/test/FixWord.cpp
249 ${CMAKE_CURRENT_SOURCE_DIR}/test/GeneratorMagicNumber.cpp
250 ${CMAKE_CURRENT_SOURCE_DIR}/test/HexFloat.cpp
251 ${CMAKE_CURRENT_SOURCE_DIR}/test/ImmediateInt.cpp
252 ${CMAKE_CURRENT_SOURCE_DIR}/test/LibspirvMacros.cpp
253 ${CMAKE_CURRENT_SOURCE_DIR}/test/NamedId.cpp
254 ${CMAKE_CURRENT_SOURCE_DIR}/test/OpcodeMake.cpp
255 ${CMAKE_CURRENT_SOURCE_DIR}/test/OpcodeRequiresCapabilities.cpp
256 ${CMAKE_CURRENT_SOURCE_DIR}/test/OpcodeSplit.cpp
257 ${CMAKE_CURRENT_SOURCE_DIR}/test/OpcodeTableGet.cpp
258 ${CMAKE_CURRENT_SOURCE_DIR}/test/OperandCapabilities.cpp
259 ${CMAKE_CURRENT_SOURCE_DIR}/test/Operand.cpp
260 ${CMAKE_CURRENT_SOURCE_DIR}/test/OperandPattern.cpp
261 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextAdvance.cpp
262 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextDestroy.cpp
263 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextLiteral.cpp
264 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextStartsNewInst.cpp
265 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextToBinary.Annotation.cpp
266 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextToBinary.Barrier.cpp
267 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextToBinary.Constant.cpp
268 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextToBinary.ControlFlow.cpp
269 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextToBinary.cpp
270 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextToBinary.Debug.cpp
271 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextToBinary.DeviceSideEnqueue.cpp
272 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextToBinary.Extension.cpp
273 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextToBinary.Function.cpp
274 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextToBinary.Group.cpp
275 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextToBinary.Image.cpp
276 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextToBinary.Literal.cpp
277 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextToBinary.Memory.cpp
278 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextToBinary.Miscellaneous.cpp
279 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextToBinary.ModeSetting.cpp
280 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextToBinary.TypeDeclaration.cpp
281 ${CMAKE_CURRENT_SOURCE_DIR}/test/TextWordGet.cpp
282 ${CMAKE_CURRENT_SOURCE_DIR}/test/UnitSPIRV.cpp
283 ${CMAKE_CURRENT_SOURCE_DIR}/test/ValidateFixtures.cpp
284 ${CMAKE_CURRENT_SOURCE_DIR}/test/Validate.Capability.cpp
285 ${CMAKE_CURRENT_SOURCE_DIR}/test/Validate.Layout.cpp
286 ${CMAKE_CURRENT_SOURCE_DIR}/test/Validate.Storage.cpp
287 ${CMAKE_CURRENT_SOURCE_DIR}/test/Validate.SSA.cpp
288 ${CMAKE_CURRENT_SOURCE_DIR}/test/ValidateID.cpp
289 ${CMAKE_CURRENT_SOURCE_DIR}/test/ValidationState.cpp
290 ${CMAKE_CURRENT_SOURCE_DIR}/test/Version.cpp
291 ${CMAKE_CURRENT_SOURCE_DIR}/test/main.cpp)
293 add_executable(UnitSPIRV ${TEST_SOURCES})
294 spvtools_default_compile_options(UnitSPIRV)
295 if(${COMPILER_IS_LIKE_GNU})
296 target_compile_options(UnitSPIRV PRIVATE -Wno-undef)
298 if(${CMAKE_CXX_COMPILER_ID} STREQUAL "MSVC")
299 # Disable C4503 "decorated name length exceeded" warning, triggered
300 # by some heavily templated types.
301 # We don't care much about that in test code.
302 # Important to do since we have warnings-as-errors.
303 target_compile_options(UnitSPIRV PRIVATE /wd4503)
305 target_include_directories(UnitSPIRV PRIVATE
306 ${CMAKE_CURRENT_SOURCE_DIR}
307 ${gmock_SOURCE_DIR}/include ${gtest_SOURCE_DIR}/include)
308 target_link_libraries(UnitSPIRV PRIVATE ${SPIRV_TOOLS} gmock)
309 add_test(NAME spirv-tools-testsuite COMMAND UnitSPIRV)
311 message(STATUS "Did not find googletest, tests will not be built."
312 "To enable tests place googletest in '<spirv-dir>/external/googletest'.")
316 install(TARGETS ${SPIRV_INSTALL_TARGETS}
317 RUNTIME DESTINATION bin
318 LIBRARY DESTINATION lib
319 ARCHIVE DESTINATION lib)
321 install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/include/spirv-tools/libspirv.h
322 DESTINATION include/spirv-tools/)
323 # The installation is broken without these header files from the SPIR-V Registry.
324 # The libspirv.h header includes them.
325 install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/include/spirv/spirv.h
326 ${CMAKE_CURRENT_SOURCE_DIR}/include/spirv/GLSL.std.450.h
327 ${CMAKE_CURRENT_SOURCE_DIR}/include/spirv/OpenCL.std.h
328 DESTINATION include/spirv/)