eden-emu/Vulkan-Utility-Libraries
14
0
Fork 0
mirror of https://github.com/KhronosGroup/Vulkan-Utility-Libraries.git synced 2025-05-14 16:58:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Ensure all header files shipped have the vk_ prefix

Browse source 
CI will fail now if we ship a .h / .hpp file that doesn't use
the correct prefix.

I also documented the precedent for this prefix and the existing
integration testing.
This commit is contained in:
Juan Ramos 2023-09-08 10:57:24 -06:00 • committed by Juan Ramos
parent a3235b3e7f
commit 6710b67cde
16 changed files with 124 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/ci.yml vendored
View file

@ -44,7 +44,7 @@ jobs:
cmake --build tests/find_package/build --config ${{matrix.config}} --verbose
- name: Test add_subdirectory support
run: |
cmake -S tests/add_subdirectory -B tests/add_subdirectory/build -D CMAKE_BUILD_TYPE=${{matrix.config}} -D GITHUB_VULKAN_HEADER_SOURCE_DIR=${{ github.workspace }}/external/${{matrix.config}}/Vulkan-Headers/
cmake -S tests/add_subdirectory -B tests/add_subdirectory/build -D CMAKE_BUILD_TYPE=${{matrix.config}} -D VULKAN_HEADER_SOURCE_DIR=${{ github.workspace }}/external/${{matrix.config}}/Vulkan-Headers/
cmake --build tests/add_subdirectory/build --config ${{matrix.config}} --verbose
android:

2
BUILD.gn
View file

@ -15,7 +15,7 @@ static_library("vulkan_layer_settings") {
"include/vulkan/layer/vk_layer_settings.h",
"include/vulkan/layer/vk_layer_settings.hpp",
"include/vulkan/layer/vk_layer_settings_ext.h",
"include/vulkan/utility/vul_dispatch_table.h",
"include/vulkan/utility/vk_dispatch_table.h",
"include/vulkan/vk_enum_string_helper.h",
"src/layer/layer_settings_manager.cpp",
"src/layer/layer_settings_manager.hpp",

2
docs/generated_code.md
View file

@ -27,7 +27,7 @@ If only dealing with a single file, run `scripts/generate_source.py` with `--ta
```bash
# Example - only generates chassis.h
scripts/generate_source.py external/Vulkan-Headers/registry/ --target vul_dispatch_table.h
scripts/generate_source.py external/Vulkan-Headers/registry/ --target vk_dispatch_table.h
```
When making change to the `scripts/` folder, make sure to run `generate_source.py`

2
include/CMakeLists.txt
View file

@ -21,7 +21,7 @@ lunarg_target_compiler_configurations(VulkanUtilityHeaders VUL_WERROR)
# https://cmake.org/cmake/help/latest/release/3.19.html#other
if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.19")
target_sources(VulkanUtilityHeaders PRIVATE
vulkan/utility/vul_dispatch_table.h
vulkan/utility/vk_dispatch_table.h
vulkan/vk_enum_string_helper.h
)
endif()

0
include/vulkan/utility/vul_dispatch_table.h → include/vulkan/utility/vk_dispatch_table.h
View file

2
scripts/generate_source.py
View file

@ -27,7 +27,7 @@ def RunGenerators(api: str, registry: str, targetFilter: str) -> None:
# Build up a list of all generators and custom options
generators = {
'vul_dispatch_table.h' : {
'vk_dispatch_table.h' : {
'generator' : DispatchTableOutputGenerator,
'directory' : 'include/vulkan/utility',
},

2
tests/CMakeLists.txt
View file

@ -5,4 +5,4 @@
# SPDX-License-Identifier: Apache-2.0
add_subdirectory(layer)
add_subdirectory(generated)
add_subdirectory(vul_dispatch_table)
add_subdirectory(vk_dispatch_table)

41
tests/README.md Normal file
View file

@ -0,0 +1,41 @@
<!--
Copyright 2023 The Khronos Group Inc.
Copyright 2023 Valve Corporation
Copyright 2023 LunarG, Inc.
SPDX-License-Identifier: Apache-2.0
-->
# Library integration testing
In order to avoid disruption of downstream users. It's important to test how this
repository is consumed.
1. Self contained headers
It's easy to write header files that aren't self contained. By compiling
a single source file that includes a single header we ensure a smooth experience for
downstream users.
2. Ensure C compatibility of C header files
It's VERY easy to write invalid C code. Especially for experience C++ programmers.
## tests/find_package
Test find_package support. The intent is to ensure we properly install files.
Used by system/language package managers and the Vulkan SDK packaging.
## tests/add_subdirectory
1. Test add_subdirectory support
While we don't have to support add_subdirectory it is a common feature request for CMake projects.
2. Ensure file name consistency of header files we install
All header files we ship will have the `vk_` prefix
This convention was originally established in VulkanHeaders for files created by LunarG.
- EX: `vk_icd.h`, `vk_layer.h`, `vk_platform.h`

59
tests/add_subdirectory/CMakeLists.txt
View file

@ -7,28 +7,55 @@ cmake_minimum_required(VERSION 3.17)
project(TEST_ADD_SUBDIRECTORY LANGUAGES C)
if (NOT DEFINED VULKAN_HEADER_SOURCE_DIR)
message(FATAL_ERROR "VULKAN_HEADER_SOURCE_DIR not defined!")
endif()
add_subdirectory(${VULKAN_HEADER_SOURCE_DIR} ${PROJECT_BINARY_DIR}/headers)
add_subdirectory(${PROJECT_SOURCE_DIR}/../../ ${PROJECT_BINARY_DIR}/vul)
get_filename_component(VUL_INCLUDE_DIR "${PROJECT_SOURCE_DIR}/../../include/" ABSOLUTE)
# Get all the header files we SHIP
file(GLOB_RECURSE public_headers
CONFIGURE_DEPENDS
"${VUL_INCLUDE_DIR}/*.h" "${VUL_INCLUDE_DIR}/*.hpp"
)
# Ensure each file has the same `vk_` prefix naming convention.
foreach(header IN LISTS public_headers)
get_filename_component(header ${header} "NAME")
message(DEBUG "Checking ${header}")
if (${header} MATCHES "^vk_")
message(DEBUG "Correct naming convention!")
else()
# EX: "Invalid file name! vk_dispatch_table.h"
message(FATAL_ERROR "Invalid file name! ${header}")
endif()
endforeach()
# The intent is ensuring we don't accidentally change the names of these
# targets. Since it would break downstream users.
if (NOT TARGET Vulkan::LayerSettings)
message(FATAL_ERROR "Vulkan::LayerSettings target not defined!")
endif()
if (NOT TARGET Vulkan::UtilityHeaders)
message(FATAL_ERROR "Vulkan::UtilityHeaders target not defined!")
endif()
add_library(add_subdirectory_example STATIC)
# Test c99 support
target_compile_features(add_subdirectory_example PRIVATE c_std_99)
target_sources(add_subdirectory_example PRIVATE
client.c
vk_dispatch_table.c
vk_enum_string_helper.c
vul_dispatch_table.c
vk_layer_settings.c
)
# NOTE: Because VulkanHeaders is a PUBLIC dependency it needs to be found prior to VulkanUtilityLibraries
add_subdirectory(${GITHUB_VULKAN_HEADER_SOURCE_DIR} ${PROJECT_BINARY_DIR}/headers)
add_subdirectory(${PROJECT_SOURCE_DIR}/../../ ${PROJECT_BINARY_DIR}/vul)
if (NOT TARGET Vulkan::LayerSettings)
message(FATAL_ERROR "Vulkan::LayerSettings target not defined!")
endif()
if (NOT TARGET Vulkan::UtilityHeaders)
message(FATAL_ERROR "Vulkan::UtilityHeaders target not defined!")
endif()
target_link_libraries(add_subdirectory_example PRIVATE Vulkan::LayerSettings Vulkan::UtilityHeaders)
target_link_libraries(add_subdirectory_example PRIVATE
Vulkan::LayerSettings
Vulkan::UtilityHeaders
)

8
tests/add_subdirectory/vul_dispatch_table.c → tests/add_subdirectory/vk_dispatch_table.c
View file

@ -3,21 +3,21 @@
// Copyright 2023 LunarG, Inc.
//
// SPDX-License-Identifier: Apache-2.0
#include <vulkan/utility/vul_dispatch_table.h>
#include <vulkan/utility/vk_dispatch_table.h>
PFN_vkVoidFunction local_vkGetInstanceProcAddr(VkInstance instance, const char *pName) {
PFN_vkVoidFunction VKAPI_PTR local_vkGetInstanceProcAddr(VkInstance instance, const char *pName) {
(void)instance;
(void)pName;
return NULL;
}
PFN_vkVoidFunction local_vkGetDeviceProcAddr(VkDevice device, const char *pName) {
PFN_vkVoidFunction VKAPI_PTR local_vkGetDeviceProcAddr(VkDevice device, const char *pName) {
(void)device;
(void)pName;
return NULL;
}
void foobar() {
void vk_dispatch_table() {
VulDeviceDispatchTable device_dispatch_table;
VulInstanceDispatchTable instance_dispatch_table;

2
tests/add_subdirectory/vk_enum_string_helper.c
View file

@ -6,7 +6,7 @@
#include <vulkan/vk_enum_string_helper.h>
// Ensure vk_enum_string_helper.h can be compiled with a C compiler
const char* foobar() { return string_VkResult(VK_SUCCESS); }
const char* string_VkResult_compiles() { return string_VkResult(VK_SUCCESS); }
// Ensure string_VkPipelineStageFlagBits2 is callable by C users
const char* vk_format_feature_2_sampled_image_bit() {

2
tests/add_subdirectory/client.c → tests/add_subdirectory/vk_layer_settings.c
View file

@ -5,7 +5,7 @@
// SPDX-License-Identifier: Apache-2.0
#include <vulkan/layer/vk_layer_settings.h>
VkBool32 foobar() {
VkBool32 vk_layer_settings() {
VlLayerSettingSet layerSettingSet = VK_NULL_HANDLE;
vlCreateLayerSettingSet("VK_LAYER_LUNARG_test", NULL, NULL, NULL, &layerSettingSet);

4
tests/find_package/CMakeLists.txt
View file

@ -13,9 +13,9 @@ add_library(find_package_example STATIC)
target_compile_features(find_package_example PRIVATE c_std_99)
target_sources(find_package_example PRIVATE
${CMAKE_CURRENT_LIST_DIR}/../add_subdirectory/client.c
${CMAKE_CURRENT_LIST_DIR}/../add_subdirectory/vk_layer_settings.c
${CMAKE_CURRENT_LIST_DIR}/../add_subdirectory/vk_enum_string_helper.c
${CMAKE_CURRENT_LIST_DIR}/../add_subdirectory/vul_dispatch_table.c
${CMAKE_CURRENT_LIST_DIR}/../add_subdirectory/vk_dispatch_table.c
)
# NOTE: Because VulkanHeaders is a PUBLIC dependency it needs to be found prior to VulkanUtilityLibraries

24
tests/vk_dispatch_table/CMakeLists.txt Normal file
View file

@ -0,0 +1,24 @@
# Copyright 2023 The Khronos Group Inc.
# Copyright 2023 Valve Corporation
# Copyright 2023 LunarG, Inc.
#
# SPDX-License-Identifier: Apache-2.0
set(CMAKE_FOLDER "${CMAKE_FOLDER}/VulkanUtilityHeaders/tests")
find_package(GTest REQUIRED CONFIG)
include(GoogleTest)
add_executable(test_vk_dispatch_table test_interface.cpp)
lunarg_target_compiler_configurations(test_vk_dispatch_table VUL_WERROR)
target_link_libraries(test_vk_dispatch_table PRIVATE
GTest::gtest
GTest::gtest_main
Vulkan::UtilityHeaders
)
target_include_directories(test_vk_dispatch_table PRIVATE $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>)
gtest_discover_tests(test_vk_dispatch_table)

4
tests/vul_dispatch_table/test_interface.cpp → tests/vk_dispatch_table/test_interface.cpp
View file

@ -7,7 +7,7 @@
#include <gtest/gtest.h>
#include <vulkan/utility/vul_dispatch_table.h>
#include <vulkan/utility/vk_dispatch_table.h>
// Only exists so that local_vkGetDeviceProcAddr can return a 'real' function pointer
inline void empty_func() {}
@ -27,7 +27,7 @@ inline PFN_vkVoidFunction local_vkGetDeviceProcAddr(VkDevice device, const char
return reinterpret_cast<PFN_vkVoidFunction>(&empty_func);
}
TEST(test_vul_dispatch_table, cpp_interface) {
TEST(test_vk_dispatch_table, cpp_interface) {
VulDeviceDispatchTable device_dispatch_table{};
VulInstanceDispatchTable instance_dispatch_table{};

24
tests/vul_dispatch_table/CMakeLists.txt
View file

@ -1,24 +0,0 @@
# Copyright 2023 The Khronos Group Inc.
# Copyright 2023 Valve Corporation
# Copyright 2023 LunarG, Inc.
#
# SPDX-License-Identifier: Apache-2.0
set(CMAKE_FOLDER "${CMAKE_FOLDER}/VulkanUtilityHeaders/tests")
find_package(GTest REQUIRED CONFIG)
include(GoogleTest)
add_executable(test_vul_dispatch_table test_interface.cpp)
lunarg_target_compiler_configurations(test_vul_dispatch_table VUL_WERROR)
target_link_libraries(test_vul_dispatch_table PRIVATE
GTest::gtest
GTest::gtest_main
Vulkan::UtilityHeaders
)
target_include_directories(test_vul_dispatch_table PRIVATE $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>)
gtest_discover_tests(test_vul_dispatch_table)