1# ~~~
2# Copyright (c) 2014-2019 Valve Corporation
3# Copyright (c) 2014-2019 LunarG, Inc.
4#
5# Licensed under the Apache License, Version 2.0 (the "License");
6# you may not use this file except in compliance with the License.
7# You may obtain a copy of the License at
8#
9#     http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an "AS IS" BASIS,
13# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14# See the License for the specific language governing permissions and
15# limitations under the License.
16# ~~~
17
18if(WIN32)
19    add_definitions(-DVK_USE_PLATFORM_WIN32_KHR -DVK_USE_PLATFORM_WIN32_KHX -DWIN32_LEAN_AND_MEAN)
20    add_custom_target(mk_layer_config_dir ALL
21                      COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/$<CONFIG>)
22    set_target_properties(mk_layer_config_dir PROPERTIES FOLDER ${LAYERS_HELPER_FOLDER})
23elseif(ANDROID)
24    add_definitions(-DVK_USE_PLATFORM_ANDROID_KHR -DVK_USE_PLATFORM_ANDROID_KHX)
25elseif(APPLE)
26    add_definitions(-DVK_USE_PLATFORM_MACOS_MVK)
27    if(CMAKE_GENERATOR MATCHES "^Xcode.*")
28        add_custom_target(mk_layer_config_dir ALL
29                          COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/$<CONFIG>)
30    endif()
31elseif(UNIX AND NOT APPLE) # i.e. Linux
32    if(BUILD_WSI_XCB_SUPPORT)
33        add_definitions(-DVK_USE_PLATFORM_XCB_KHR -DVK_USE_PLATFORM_XCB_KHX)
34    endif()
35
36    if(BUILD_WSI_XLIB_SUPPORT)
37        add_definitions(-DVK_USE_PLATFORM_XLIB_KHR -DVK_USE_PLATFORM_XLIB_KHX -DVK_USE_PLATFORM_XLIB_XRANDR_EXT)
38    endif()
39
40    if(BUILD_WSI_WAYLAND_SUPPORT)
41        add_definitions(-DVK_USE_PLATFORM_WAYLAND_KHR -DVK_USE_PLATFORM_WAYLAND_KHX)
42    endif()
43else()
44    message(FATAL_ERROR "Unsupported Platform!")
45endif()
46
47# Custom targets for generated validation layer helper file dependencies
48add_custom_target(spirv_tools_revision_file DEPENDS spirv_tools_commit_id.h)
49set_target_properties(spirv_tools_revision_file PROPERTIES FOLDER ${LAYERS_HELPER_FOLDER})
50
51if(BUILD_LAYERS)
52    # generate header file containing commit IDs of external dependencies
53    add_custom_command(OUTPUT spirv_tools_commit_id.h
54                       COMMAND ${PYTHON_EXECUTABLE} ${SCRIPTS_DIR}/external_revision_generator.py
55                               --from_uuid -s SPIRV_TOOLS_COMMIT_ID -o spirv_tools_commit_id.h
56                       DEPENDS ${SCRIPTS_DIR}/external_revision_generator.py)
57endif()
58
59# Configure installation of source files that are dependencies of other repos.
60set(LAYER_UTIL_FILES
61    hash_util.h
62    hash_vk_types.h
63    vk_format_utils.h
64    vk_format_utils.cpp
65    vk_layer_config.h
66    vk_layer_config.cpp
67    vk_layer_data.h
68    vk_layer_extension_utils.h
69    vk_layer_extension_utils.cpp
70    vk_layer_logging.h
71    vk_layer_utils.h
72    vk_layer_utils.cpp
73    vk_loader_layer.h
74    vk_loader_platform.h
75    vk_validation_error_messages.h
76    ${PROJECT_BINARY_DIR}/vk_layer_dispatch_table.h
77    ${PROJECT_BINARY_DIR}/vk_dispatch_table_helper.h
78    ${PROJECT_BINARY_DIR}/vk_safe_struct.h
79    ${PROJECT_BINARY_DIR}/vk_safe_struct.cpp
80    ${PROJECT_BINARY_DIR}/vk_enum_string_helper.h
81    ${PROJECT_BINARY_DIR}/vk_object_types.h
82    ${PROJECT_BINARY_DIR}/vk_extension_helper.h
83    ${PROJECT_BINARY_DIR}/vk_typemap_helper.h)
84install(FILES ${LAYER_UTIL_FILES} DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
85
86set(TARGET_NAMES
87    VkLayer_core_validation
88    VkLayer_object_lifetimes
89    VkLayer_unique_objects
90    VkLayer_stateless_validation
91    VkLayer_standard_validation
92    VkLayer_thread_safety)
93
94if(BUILD_LAYERS)
95    # Install the layer json files
96    if(WIN32)
97        if(CMAKE_GENERATOR MATCHES "^Visual Studio.*")
98            foreach(TARGET_NAME ${TARGET_NAMES})
99                install(FILES ${CMAKE_CURRENT_BINARY_DIR}/$<CONFIG>/${TARGET_NAME}.json DESTINATION ${CMAKE_INSTALL_LIBDIR})
100            endforeach()
101        else()
102            foreach(TARGET_NAME ${TARGET_NAMES})
103                install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}.json DESTINATION ${CMAKE_INSTALL_LIBDIR})
104            endforeach()
105        endif()
106    elseif(UNIX) # UNIX includes APPLE
107        foreach(TARGET_NAME ${TARGET_NAMES})
108            install(FILES ${CMAKE_CURRENT_BINARY_DIR}/staging-json/${TARGET_NAME}.json
109                    DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/vulkan/explicit_layer.d)
110        endforeach()
111    endif()
112endif()
113
114# System-specific macros to create a library target.
115if(WIN32)
116    macro(AddVkLayer target LAYER_COMPILE_DEFINITIONS)
117        file(TO_NATIVE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/VkLayer_${target}.def DEF_FILE)
118        add_custom_target(copy-${target}-def-file ALL
119                          COMMAND ${CMAKE_COMMAND} -E copy_if_different ${DEF_FILE} VkLayer_${target}.def
120                          VERBATIM)
121        set_target_properties(copy-${target}-def-file PROPERTIES FOLDER ${LAYERS_HELPER_FOLDER})
122
123        add_library(VkLayer_${target} SHARED ${ARGN} VkLayer_${target}.def)
124        target_compile_definitions(VkLayer_${target} PUBLIC ${LAYER_COMPILE_DEFINITIONS})
125        target_link_libraries(VkLayer_${target} PRIVATE VkLayer_utils)
126        add_dependencies(VkLayer_${target} VulkanVL_generate_helper_files VulkanVL_generate_chassis_files VkLayer_utils)
127        install(TARGETS VkLayer_${target} DESTINATION ${CMAKE_INSTALL_LIBDIR})
128    endmacro()
129elseif(APPLE)
130    macro(AddVkLayer target LAYER_COMPILE_DEFINITIONS)
131        add_library(VkLayer_${target} SHARED ${ARGN})
132        target_compile_definitions(VkLayer_${target} PUBLIC ${LAYER_COMPILE_DEFINITIONS})
133        target_link_libraries(VkLayer_${target} PRIVATE VkLayer_utils)
134        add_dependencies(VkLayer_${target} VulkanVL_generate_helper_files VulkanVL_generate_chassis_files VkLayer_utils)
135        set_target_properties(VkLayer_${target}
136                              PROPERTIES LINK_FLAGS
137                                         "-Wl"
138                                         INSTALL_RPATH
139                                         "@loader_path/")
140        install(TARGETS VkLayer_${target} DESTINATION ${CMAKE_CURRENT_BINARY_DIR})
141    endmacro()
142else(UNIX AND NOT APPLE) # i.e.: Linux
143    macro(AddVkLayer target LAYER_COMPILE_DEFINITIONS)
144        add_library(VkLayer_${target} SHARED ${ARGN})
145        target_compile_definitions(VkLayer_${target} PUBLIC ${LAYER_COMPILE_DEFINITIONS})
146        target_link_libraries(VkLayer_${target} PRIVATE VkLayer_utils)
147        add_dependencies(VkLayer_${target} VulkanVL_generate_helper_files VulkanVL_generate_chassis_files VkLayer_utils)
148        set_target_properties(VkLayer_${target} PROPERTIES LINK_FLAGS "-Wl,-Bsymbolic,--exclude-libs,ALL")
149        install(TARGETS VkLayer_${target} DESTINATION ${CMAKE_INSTALL_LIBDIR})
150    endmacro()
151endif()
152
153include_directories(${CMAKE_CURRENT_SOURCE_DIR} ${VulkanHeaders_INCLUDE_DIR})
154
155if(WIN32)
156    # Applies to all configurations
157    add_definitions(-D_CRT_SECURE_NO_WARNINGS)
158    # Avoid: fatal error C1128: number of sections exceeded object file format limit: compile with /bigobj
159    add_compile_options("/bigobj")
160    # Turn off transitional "changed behavior" warning message for Visual Studio versions prior to 2015. The changed behavior is
161    # that constructor initializers are now fixed to clear the struct members.
162    add_compile_options("$<$<AND:$<CXX_COMPILER_ID:MSVC>,$<VERSION_LESS:$<CXX_COMPILER_VERSION>,19>>:/wd4351>")
163else()
164    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wpointer-arith -Wno-unused-function -Wno-sign-compare")
165    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wpointer-arith -Wno-unused-function -Wno-sign-compare")
166endif()
167
168# Clang warns about unused const variables. Generated files may purposely contain unused consts, so silence this warning in Clang
169if(CMAKE_C_COMPILER_ID MATCHES "Clang")
170    set_source_files_properties(parameter_validation.cpp PROPERTIES COMPILE_FLAGS "-Wno-unused-const-variable")
171endif()
172
173GenerateFromVkXml(thread_safety_generator.py thread_safety.h)
174GenerateFromVkXml(thread_safety_generator.py thread_safety.cpp)
175GenerateFromVkXml(parameter_validation_generator.py parameter_validation.cpp)
176GenerateFromVkXml(parameter_validation_generator.py parameter_validation.h)
177GenerateFromVkXml(dispatch_table_helper_generator.py vk_dispatch_table_helper.h)
178GenerateFromVkXml(object_tracker_generator.py object_tracker.cpp)
179GenerateFromVkXml(object_tracker_generator.py object_tracker.h)
180GenerateFromVkXml(layer_chassis_generator.py chassis.cpp)
181GenerateFromVkXml(layer_chassis_generator.py chassis.h)
182GenerateFromVkXml(layer_chassis_dispatch_generator.py layer_chassis_dispatch.h)
183GenerateFromVkXml(layer_chassis_dispatch_generator.py layer_chassis_dispatch.cpp)
184
185# This target causes the chassis source files to be generated.
186add_custom_target(VulkanVL_generate_chassis_files
187                  DEPENDS chassis.cpp
188                          chassis.h
189                          layer_chassis_dispatch.h
190                          layer_chassis_dispatch.cpp)
191set_target_properties(VulkanVL_generate_chassis_files PROPERTIES FOLDER ${LAYERS_HELPER_FOLDER})
192
193# Inter-layer dependencies are temporarily necessary to serialize layer builds which avoids contention for common generated files
194if(BUILD_LAYERS)
195    AddVkLayer(core_validation "BUILD_CORE_VALIDATION" chassis.cpp layer_chassis_dispatch.cpp core_validation.cpp convert_to_renderpass2.cpp descriptor_sets.cpp buffer_validation.cpp shader_validation.cpp gpu_validation.cpp xxhash.c)
196    add_dependencies(VkLayer_core_validation VulkanVL_generate_chassis_files)
197    AddVkLayer(object_lifetimes "BUILD_OBJECT_TRACKER" object_tracker.cpp object_tracker.h object_tracker_utils.cpp chassis.cpp layer_chassis_dispatch.cpp)
198    add_dependencies(VkLayer_object_lifetimes VkLayer_core_validation)
199    AddVkLayer(thread_safety "BUILD_THREAD_SAFETY" thread_safety.cpp thread_safety.h chassis.cpp layer_chassis_dispatch.cpp)
200    add_dependencies(VkLayer_thread_safety VkLayer_object_lifetimes)
201    AddVkLayer(unique_objects "LAYER_CHASSIS_CAN_WRAP_HANDLES" chassis.cpp layer_chassis_dispatch.cpp)
202    add_dependencies(VkLayer_unique_objects VkLayer_thread_safety)
203    AddVkLayer(stateless_validation "BUILD_PARAMETER_VALIDATION" parameter_validation.cpp parameter_validation.h parameter_validation_utils.cpp chassis.cpp layer_chassis_dispatch.cpp)
204    add_dependencies(VkLayer_stateless_validation VkLayer_unique_objects)
205
206    # Core validation has additional dependencies
207    target_include_directories(VkLayer_core_validation PRIVATE ${GLSLANG_SPIRV_INCLUDE_DIR})
208    target_include_directories(VkLayer_core_validation PRIVATE ${SPIRV_TOOLS_INCLUDE_DIR})
209    target_link_libraries(VkLayer_core_validation PRIVATE ${SPIRV_TOOLS_LIBRARIES})
210    add_dependencies(VkLayer_core_validation spirv_tools_revision_file)
211
212    # The output file needs Unix "/" separators or Windows "\" separators On top of that, Windows separators actually need to be doubled
213    # because the json format uses backslash escapes
214    file(TO_NATIVE_PATH "./" RELATIVE_PATH_PREFIX)
215    string(REPLACE "\\"
216                   "\\\\"
217                   RELATIVE_PATH_PREFIX
218                   "${RELATIVE_PATH_PREFIX}")
219
220    # Run each .json.in file through the generator We need to create the generator.cmake script so that the generator can be run at
221    # compile time, instead of configure time Running at compile time lets us use cmake generator expressions (TARGET_FILE_NAME and
222    # TARGET_FILE_DIR, specifically)
223    file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/generator.cmake" "configure_file(\"\${INPUT_FILE}\" \"\${OUTPUT_FILE}\")")
224    foreach(TARGET_NAME ${TARGET_NAMES})
225        set(CONFIG_DEFINES -DINPUT_FILE="${CMAKE_CURRENT_SOURCE_DIR}/json/${TARGET_NAME}.json.in" -DVK_VERSION=1.1.${vk_header_version})
226        # If this json file is not a metalayer, get the needed properties from that target
227        if(TARGET ${TARGET_NAME})
228            set(CONFIG_DEFINES
229                ${CONFIG_DEFINES}
230                -DOUTPUT_FILE="$<TARGET_FILE_DIR:${TARGET_NAME}>/${TARGET_NAME}.json"
231                -DRELATIVE_LAYER_BINARY="${RELATIVE_PATH_PREFIX}$<TARGET_FILE_NAME:${TARGET_NAME}>")
232            # If this json file is a metalayer, make the output path match core validation, and there is no layer binary file
233        else()
234            set(CONFIG_DEFINES ${CONFIG_DEFINES} -DOUTPUT_FILE="$<TARGET_FILE_DIR:VkLayer_core_validation>/${TARGET_NAME}.json")
235        endif()
236        add_custom_target(${TARGET_NAME}-json ALL
237                          COMMAND ${CMAKE_COMMAND} ${CONFIG_DEFINES} -P "${CMAKE_CURRENT_BINARY_DIR}/generator.cmake")
238        if(CMAKE_GENERATOR MATCHES "^Visual Studio.*")
239            set_target_properties(${TARGET_NAME}-json PROPERTIES FOLDER ${LAYERS_HELPER_FOLDER})
240        endif()
241    endforeach()
242
243    # For UNIX-based systems, `library_path` should not contain a relative path (indicated by "./") before installing to system
244    # directories, so we do not include it in the staging-json files which are used for installation
245    if(UNIX)
246        foreach(TARGET_NAME ${TARGET_NAMES})
247            set(INSTALL_DEFINES
248                -DINPUT_FILE="${CMAKE_CURRENT_SOURCE_DIR}/json/${TARGET_NAME}.json.in"
249                -DOUTPUT_FILE="${CMAKE_CURRENT_BINARY_DIR}/staging-json/${TARGET_NAME}.json"
250                -DVK_VERSION=1.1.${vk_header_version})
251            # If this json file is not a metalayer, get the needed properties from that target
252            if(TARGET ${TARGET_NAME})
253                set(INSTALL_DEFINES ${INSTALL_DEFINES} -DRELATIVE_LAYER_BINARY="$<TARGET_FILE_NAME:${TARGET_NAME}>")
254            endif()
255            add_custom_target(${TARGET_NAME}-staging-json ALL
256                              COMMAND ${CMAKE_COMMAND} ${INSTALL_DEFINES} -P "${CMAKE_CURRENT_BINARY_DIR}/generator.cmake")
257        endforeach()
258    endif()
259endif()
260