build: Downstream Vulkan-Loader 1.3.278

.github/workflows/codeql.yml

@@ -86,7 +86,7 @@ jobs:
 
     - name: Generate build files
       if: matrix.language == 'cpp'
-      run: cmake -S. -B build -D CMAKE_BUILD_TYPE=Release -D UPDATE_DEPS=ON -D LOADER_ENABLE_ADDRESS_SANITIZER=ON -D ENABLE_WERROR=ON
+      run: cmake -S. -B build -D CMAKE_BUILD_TYPE=Release -D UPDATE_DEPS=ON
       env:
         CC: gcc
         CXX: g++

.github/workflows/format.yml

@@ -26,7 +26,6 @@ permissions:
 
 jobs:
   clang-format:
-    if: ${{ !contains(github.event.head_commit.message, 'Downstream Vulkan-Loader') }}
     name: clang-format
     runs-on: ubuntu-latest
     strategy:

BUILD.md

@@ -16,6 +16,7 @@ Instructions for building this repository on Linux, Windows, and MacOS.
     - [Repository Dependencies](#repository-dependencies)
       - [Vulkan-Headers](#vulkan-headers)
       - [Test Dependencies](#test-dependencies)
+    - [Warnings as errors off by default!](#warnings-as-errors-off-by-default)
     - [Build and Install Directory Locations](#build-and-install-directory-locations)
     - [Building Dependent Repositories with Known-Good Revisions](#building-dependent-repositories-with-known-good-revisions)
       - [Automatically](#automatically)
@@ -132,6 +133,16 @@ cmake ... -D UPDATE_DEPS=ON -D BUILD_TESTS=ON ...
 ```
 This will ensure googletest and detours is downloaded and the appropriate version is used.
 
+### Warnings as errors off by default!
+
+By default `BUILD_WERROR` is `OFF`. The idiom for open source projects is to NOT enable warnings as errors.
+
+System/language package managers have to build on multiple different platforms and compilers.
+
+By defaulting to `ON` we cause issues for package managers since there is no standard way to disable warnings.
+
+Add `-D BUILD_WERROR=ON` to your workflow
+
 ### Build and Install Directory Locations
 
 A common convention is to place the `build` directory in the top directory of

CMakeLists.txt

@@ -22,9 +22,9 @@ cmake_minimum_required(VERSION 3.17.2)
 set(VULKANSC OFF CACHE BOOL "User defined variable for VULKANSC mode to be passed in through cmake command line e.g. -DVULKANSC=ON")
 
 if(VULKANSC)
-    project(VULKAN_LOADER VERSION 1.0.14)
+    project(VULKAN_LOADER VERSION 1.0.14 LANGUAGES C)
 else()
-    project(VULKAN_LOADER VERSION 1.3.272)
+    project(VULKAN_LOADER VERSION 1.3.278 LANGUAGES C)
 endif()
 
 # This variable enables downstream users to customize the target API
@@ -40,8 +40,11 @@ endif()
 
 add_subdirectory(scripts)
 
-set(THREADS_PREFER_PTHREAD_FLAG ON)
-find_package(Threads REQUIRED)
+set(CMAKE_C_STANDARD 99)
+set(CMAKE_C_STANDARD_REQUIRED ON)
+set(CMAKE_C_EXTENSIONS OFF)
+set(CMAKE_C_VISIBILITY_PRESET "hidden")
+set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
 
 # By default, loader & tests are built without sanitizers
 # Use these options to force a specific sanitizer on the loader and test executables
@@ -95,18 +98,16 @@ if(UNIX)
             "System-wide search directory. If not set or empty, CMAKE_INSTALL_FULL_SYSCONFDIR and /etc are used.")
 endif()
 
-# For MSVC/Windows, replace /GR with an empty string, this prevents warnings of /GR being overriden by /GR-
-# Newer CMake versions (3.20) have better solutions for this through policy - using the old
-# way while waiting for when updating can occur
-string(REPLACE "/GR" "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
-
 if(WIN32)
     option(ENABLE_WIN10_ONECORE "Link the loader with OneCore umbrella libraries" OFF)
 endif()
 
 add_library(platform_wsi INTERFACE)
 if(WIN32)
-    if(NOT VULKANSC)
+    if(VULKANSC)
+        # Explicitly define WIN32 as some compiler stacks (e.g. clang) do not define it automatically
+        add_definitions(-DWIN32)
+    else()
         target_compile_definitions(platform_wsi INTERFACE VK_USE_PLATFORM_WIN32_KHR)
     endif()
 elseif(ANDROID)
@@ -184,52 +185,45 @@ target_link_libraries(loader_common_options INTERFACE platform_wsi)
 # Enable beta Vulkan extensions
 target_compile_definitions(loader_common_options INTERFACE VK_ENABLE_BETA_EXTENSIONS)
 
-target_compile_features(loader_common_options INTERFACE c_std_99)
-target_compile_features(loader_common_options INTERFACE cxx_std_17)
-set(LOADER_STANDARD_C_PROPERTIES C_STANDARD 99 C_STANDARD_REQUIRED YES C_EXTENSIONS OFF)
-set(LOADER_STANDARD_CXX_PROPERTIES CXX_STANDARD 17 CXX_STANDARD_REQUIRED YES CXX_EXTENSIONS OFF)
-
-set(TESTS_STANDARD_CXX_PROPERTIES ${LOADER_STANDARD_CXX_PROPERTIES} MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL")
-
-# Force the use of the multithreaded, static version of the C runtime.
-set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
-
-option(ENABLE_WERROR "Enable warnings as errors" ON)
+option(BUILD_WERROR "Enable warnings as errors")
 
 # Set warnings as errors and the main diagnostic flags
 # Must be set first so the warning silencing later on works properly
 # Note that clang-cl.exe should use MSVC flavor flags, not GNU
-if (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC" OR (CMAKE_CXX_COMPILER_ID STREQUAL "Clang" AND "${CMAKE_CXX_SIMULATE_ID}" MATCHES "MSVC"))
-    if (ENABLE_WERROR)
+if (CMAKE_C_COMPILER_ID STREQUAL "MSVC" OR (CMAKE_C_COMPILER_ID STREQUAL "Clang" AND CMAKE_C_COMPILER_FRONTEND_VARIANT MATCHES "MSVC"))
+    if (BUILD_WERROR)
         target_compile_options(loader_common_options INTERFACE /WX)
     endif()
     target_compile_options(loader_common_options INTERFACE /W4)
-elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU" OR CMAKE_CXX_COMPILER_ID STREQUAL "Clang" OR CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang")
+elseif(CMAKE_C_COMPILER_ID MATCHES "GNU|Clang")
     # using GCC or Clang with the regular front end
-    if (ENABLE_WERROR)
+    if (BUILD_WERROR)
         target_compile_options(loader_common_options INTERFACE -Werror)
     endif()
     target_compile_options(loader_common_options INTERFACE -Wall -Wextra)
 endif()
 
-if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU" OR CMAKE_CXX_COMPILER_ID STREQUAL "Clang" OR CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang")
+if(CMAKE_C_COMPILER_ID MATCHES "GNU|Clang")
     target_compile_options(loader_common_options INTERFACE -Wno-missing-field-initializers)
 
-    if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+    # need to prepend /clang: to compiler arguments when using clang-cl
+    if (CMAKE_C_COMPILER_ID STREQUAL "Clang" AND "${CMAKE_CXX_SIMULATE_ID}" MATCHES "MSVC")
+        target_compile_options(loader_common_options INTERFACE /clang:-fno-strict-aliasing)
+    else()
+        target_compile_options(loader_common_options INTERFACE -fno-strict-aliasing)
+    endif()
+
+    if(CMAKE_C_COMPILER_ID STREQUAL "GNU")
         target_compile_options(loader_common_options INTERFACE -Wno-stringop-truncation -Wno-stringop-overflow)
-        if (CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 7.1)
+        if (CMAKE_C_COMPILER_VERSION VERSION_GREATER_EQUAL 7.1)
             target_compile_options(loader_common_options INTERFACE -Wshadow=local) #only added in GCC 7
         endif()
     endif()
 
-    if(UNIX)
-        target_compile_options(loader_common_options INTERFACE -fvisibility=hidden)
-    endif()
-
     target_compile_options(loader_common_options INTERFACE -Wpointer-arith)
 endif()
 
-if(CMAKE_CXX_COMPILER_ID MATCHES "MSVC" OR (CMAKE_CXX_COMPILER_ID STREQUAL "Clang" AND "${CMAKE_CXX_SIMULATE_ID}" MATCHES "MSVC"))
+if(CMAKE_C_COMPILER_ID MATCHES "MSVC" OR (CMAKE_C_COMPILER_ID STREQUAL "Clang" AND CMAKE_C_COMPILER_FRONTEND_VARIANT MATCHES "MSVC"))
     # /sdl: Enable additional security checks
     # /GR-: Disable RTTI
     # /guard:cf: Enable control flow guard
@@ -295,108 +289,7 @@ endif()
 add_subdirectory(loader)
 
 option(BUILD_TESTS "Build Tests")
-if(BUILD_TESTS)
-    # Set gtest build configuration
-    # Attempt to enable if it is available.
-    if(TARGET gtest)
-        # Already enabled as a target (perhaps by a project enclosing this one)
-        message(STATUS "Vulkan-Loader/external: " "googletest already configured - using it")
-    elseif(IS_DIRECTORY "${GOOGLETEST_INSTALL_DIR}/googletest")
-        set(BUILD_GTEST ON CACHE BOOL "Builds the googletest subproject")
-        set(BUILD_GMOCK OFF CACHE BOOL "Builds the googlemock subproject")
-        set(gtest_force_shared_crt ON CACHE BOOL "Link gtest runtimes dynamically" FORCE)
-        set(BUILD_SHARED_LIBS ON CACHE BOOL "Build shared libraries")
-        set(INSTALL_GTEST OFF CACHE BOOL "Don't install gtest")
-        # The googletest directory exists, so enable it as a target.
-        message(STATUS "Vulkan-Loader/external: " "googletest found - configuring it for tests")
-        add_subdirectory("${GOOGLETEST_INSTALL_DIR}")
-    else()
-        message(SEND_ERROR "Could not find googletest directory. Be sure to run update_deps.py with the --tests option to download the appropriate version of googletest")
-        set(BUILD_TESTS OFF)
-    endif()
-
-    # make sure gtest uses the dynamic runtime instead
-    set_target_properties(gtest PROPERTIES ${TESTS_STANDARD_CXX_PROPERTIES})
-    set_target_properties(gtest_main PROPERTIES ${TESTS_STANDARD_CXX_PROPERTIES})
-
-    if (WIN32)
-        if(TARGET detours)
-            # Already enabled as a target (perhaps by a project enclosing this one)
-            message(STATUS "Vulkan-Loader/external: " "detours already configured - using it")
-        else()
-            if(IS_DIRECTORY ${DETOURS_INSTALL_DIR})
-                # The detours directory exists, so enable it as a target.
-                message(STATUS "Vulkan-Loader/external: " "detours found - configuring it for tests")
-            else()
-                message(SEND_ERROR "Could not find detours directory. Be sure to run update_deps.py with the --tests option to download the appropriate version of detours")
-                set(BUILD_TESTS OFF)
-            endif()
-            add_library(detours STATIC
-                ${DETOURS_INSTALL_DIR}/src/creatwth.cpp
-                ${DETOURS_INSTALL_DIR}/src/detours.cpp
-                ${DETOURS_INSTALL_DIR}/src/detours.h
-                ${DETOURS_INSTALL_DIR}/src/detver.h
-                ${DETOURS_INSTALL_DIR}/src/disasm.cpp
-                ${DETOURS_INSTALL_DIR}/src/disolarm.cpp
-                ${DETOURS_INSTALL_DIR}/src/disolarm64.cpp
-                ${DETOURS_INSTALL_DIR}/src/disolia64.cpp
-                ${DETOURS_INSTALL_DIR}/src/disolx64.cpp
-                ${DETOURS_INSTALL_DIR}/src/disolx86.cpp
-                ${DETOURS_INSTALL_DIR}/src/image.cpp
-                ${DETOURS_INSTALL_DIR}/src/modules.cpp
-                )
-            target_include_directories(detours PUBLIC ${DETOURS_INSTALL_DIR}/src)
-
-            macro(GET_WIN32_WINNT version)
-                if(WIN32 AND CMAKE_SYSTEM_VERSION)
-            		set(ver ${CMAKE_SYSTEM_VERSION})
-            		string(REGEX MATCH "^([0-9]+).([0-9])" ver ${ver})
-            		string(REGEX MATCH "^([0-9]+)" verMajor ${ver})
-            		# Check for Windows 10, b/c we'll need to convert to hex 'A'.
-            		if("${verMajor}" MATCHES "10")
-            			set(verMajor "A")
-            			string(REGEX REPLACE "^([0-9]+)" ${verMajor} ver ${ver})
-            		endif("${verMajor}" MATCHES "10")
-            		# Remove all remaining '.' characters.
-            		string(REPLACE "." "" ver ${ver})
-            		# Prepend each digit with a zero.
-            		string(REGEX REPLACE "([0-9A-Z])" "0\\1" ver ${ver})
-            		set(${version} "0x${ver}")
-                endif()
-            endmacro()
-
-            set(DETOURS_MAJOR_VERSION "4")
-            set(DETOURS_MINOR_VERSION "0")
-            set(DETOURS_PATCH_VERSION "1")
-            set(DETOURS_VERSION "${DETOURS_MAJOR_VERSION}.${DETOURS_MINOR_VERSION}.${DETOURS_PATCH_VERSION}")
-
-            target_include_directories(detours PUBLIC ${DETOURS_INSTALL_DIR}/src)
-
-            if(MSVC_VERSION GREATER_EQUAL 1700)
-                target_compile_definitions(detours PUBLIC DETOURS_CL_17_OR_NEWER)
-            endif(MSVC_VERSION GREATER_EQUAL 1700)
-            GET_WIN32_WINNT(ver)
-            if(ver EQUAL 0x0700)
-                target_compile_definitions(detours PUBLIC _USING_V110_SDK71_ DETOURS_WIN_7)
-            endif(ver EQUAL 0x0700)
-            target_compile_definitions(detours PUBLIC "_WIN32_WINNT=${ver}")
-
-            target_compile_definitions(detours PUBLIC  "DETOURS_VERSION=0x4c0c1" WIN32_LEAN_AND_MEAN)
-
-            if(MSVC)
-                target_compile_definitions(detours PUBLIC  "_CRT_SECURE_NO_WARNINGS=1")
-                set_target_properties(detours PROPERTIES COMPILE_FLAGS /EHsc ${TESTS_STANDARD_CXX_PROPERTIES})
-            endif()
-
-            # Silence errors found in clang-cl
-            if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang" AND "${CMAKE_CXX_SIMULATE_ID}" MATCHES "MSVC")
-                target_compile_options(detours PRIVATE -Wno-sizeof-pointer-memaccess -Wno-microsoft-goto -Wno-microsoft-cast)
-            endif()
-        endif()
-    endif()
-
-    if (BUILD_TESTS)
-        enable_testing()
-        add_subdirectory(tests)
-    endif()
+if (BUILD_TESTS)
+    enable_testing()
+    add_subdirectory(tests)
 endif()