From 86bacfd26d190109a213ac90e25b1d8d158a8ced Mon Sep 17 00:00:00 2001 From: Mrkol Date: Thu, 29 Aug 2024 02:20:11 +0300 Subject: [PATCH] Added a simple compilation test and linux CI Compilation test is required because the smaple is windows-specific. Linux CI is needed because pull requests must stop breaking linux builds. --- .github/workflows/linux.yaml | 52 +++++++++++++++++++++++++++++++++ CMakeLists.txt | 1 + compilation_test/CMakeLists.txt | 36 +++++++++++++++++++++++ compilation_test/vma_impl.cpp | 2 ++ include/vk_mem_alloc.h | 16 +++++----- 5 files changed, 99 insertions(+), 8 deletions(-) create mode 100644 .github/workflows/linux.yaml create mode 100644 compilation_test/CMakeLists.txt create mode 100644 compilation_test/vma_impl.cpp diff --git a/.github/workflows/linux.yaml b/.github/workflows/linux.yaml new file mode 100644 index 00000000..5af52d87 --- /dev/null +++ b/.github/workflows/linux.yaml @@ -0,0 +1,52 @@ +name: linux + +on: [push, pull_request] + +permissions: + contents: read + +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + cxx: [g++-12, clang++-15] + build_type: [Debug, Release] + include: + - cxx: g++-12 + install: sudo apt install g++-12 + - cxx: clang++-15 + cxxflags: -stdlib=libc++ + install: sudo apt install clang-15 libc++-15-dev libc++abi-15-dev + + steps: + - uses: actions/checkout@v4 + + - name: Prepare Vulkan SDK + uses: humbletim/install-vulkan-sdk@v1.1.1 + with: + version: 1.3.290.0 + cache: true + + - name: Create Build Environment + run: | + sudo apt update + ${{matrix.install}} + cmake -E make_directory ${{runner.workspace}}/build + + - name: Configure + working-directory: ${{runner.workspace}}/build + env: + CXX: ${{matrix.cxx}} + CXXFLAGS: ${{matrix.cxxflags}} + run: | + cmake -DCPM_SOURCE_CACHE=~/cpm-cache \ + -DCMAKE_BUILD_TYPE=${{matrix.build_type}} \ + -DVMA_BUILD_SAMPLES=YES \ + $GITHUB_WORKSPACE + + - name: Build + working-directory: ${{runner.workspace}}/build + run: | + threads=`nproc` + cmake --build . --target VmaCompilationTest --config ${{matrix.build_type}} --parallel $threads diff --git a/CMakeLists.txt b/CMakeLists.txt index 8adeb7a5..c6a5811b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -45,5 +45,6 @@ if (VMA_ENABLE_INSTALL) option(VMA_BUILD_SAMPLES "Build samples") if (VMA_BUILD_SAMPLES) add_subdirectory(src) + add_subdirectory(compilation_test) endif() endif() diff --git a/compilation_test/CMakeLists.txt b/compilation_test/CMakeLists.txt new file mode 100644 index 00000000..88428915 --- /dev/null +++ b/compilation_test/CMakeLists.txt @@ -0,0 +1,36 @@ +# +# Copyright (c) 2017-2024 Advanced Micro Devices, Inc. All rights reserved. +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +# + + +set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_STANDARD_REQUIRED ON) +set(CMAKE_CXX_EXTENSIONS OFF) + +find_package(Vulkan REQUIRED) + +add_library(VmaCompilationTest) +target_sources(VmaCompilationTest PRIVATE vma_impl.cpp) + +target_link_libraries(VmaCompilationTest PRIVATE GPUOpen::VulkanMemoryAllocator) + +target_link_libraries(VmaCompilationTest PUBLIC Vulkan::Vulkan) + diff --git a/compilation_test/vma_impl.cpp b/compilation_test/vma_impl.cpp new file mode 100644 index 00000000..7a6837cb --- /dev/null +++ b/compilation_test/vma_impl.cpp @@ -0,0 +1,2 @@ +#define VMA_IMPLEMENTATION +#include diff --git a/include/vk_mem_alloc.h b/include/vk_mem_alloc.h index 4c9e3ec9..1893a8f8 100644 --- a/include/vk_mem_alloc.h +++ b/include/vk_mem_alloc.h @@ -1467,17 +1467,17 @@ typedef struct VmaAllocationInfo typedef struct VmaAllocationInfo2 { /** \brief Basic parameters of the allocation. - + If you need only these, you can use function vmaGetAllocationInfo() and structure #VmaAllocationInfo instead. */ VmaAllocationInfo allocationInfo; /** \brief Size of the `VkDeviceMemory` block that the allocation belongs to. - + In case of an allocation with dedicated memory, it will be equal to `allocationInfo.size`. */ VkDeviceSize blockSize; /** \brief `VK_TRUE` if the allocation has dedicated memory, `VK_FALSE` if it was placed as part of a larger memory block. - + When `VK_TRUE`, it also means `VkMemoryDedicatedAllocateInfo` was used when creating the allocation (if VK_KHR_dedicated_allocation extension or Vulkan version >= 1.1 is enabled). */ @@ -2567,7 +2567,7 @@ VMA_CALL_PRE VkResult VMA_CALL_POST vmaCreateAliasingBuffer( \param allocator \param allocation Allocation that provides memory to be used for binding new buffer to it. \param allocationLocalOffset Additional offset to be added while binding, relative to the beginning of the allocation. Normally it should be 0. -\param pBufferCreateInfo +\param pBufferCreateInfo \param[out] pBuffer Buffer that was created. This function automatically: @@ -6195,7 +6195,7 @@ class VmaWin32Handle HANDLE m_hHandle; VMA_RW_MUTEX m_Mutex; // Protects access m_Handle }; -#else +#else class VmaWin32Handle { // ABI compatibility @@ -10594,7 +10594,7 @@ VmaDeviceMemoryBlock::VmaDeviceMemoryBlock(VmaAllocator hAllocator) m_hMemory(VK_NULL_HANDLE), m_MapCount(0), m_pMappedData(VMA_NULL), - m_Handle(VMA_NULL) {} + m_Handle() {} VmaDeviceMemoryBlock::~VmaDeviceMemoryBlock() { @@ -16675,7 +16675,7 @@ VMA_CALL_PRE VkResult VMA_CALL_POST vmaGetMemoryWin32Handle(VmaAllocator VMA_NOT VMA_DEBUG_GLOBAL_MUTEX_LOCK; return allocation->GetWin32Handle(allocator, hTargetProcess, pHandle); } -#endif // VMA_EXTERNAL_MEMORY_WIN32 +#endif // VMA_EXTERNAL_MEMORY_WIN32 #endif // VMA_STATS_STRING_ENABLED #endif // _VMA_PUBLIC_INTERFACE #endif // VMA_IMPLEMENTATION @@ -18929,7 +18929,7 @@ res = vmaCreateBuffer(g_Allocator, &bufCreateInfo, &allocCreateInfo, &buf, &allo vmaDestroyBuffer(g_Allocator, buf, alloc); \endcode -If you need each allocation to have its own device memory block and start at offset 0, you can still do +If you need each allocation to have its own device memory block and start at offset 0, you can still do by using #VMA_ALLOCATION_CREATE_DEDICATED_MEMORY_BIT flag. It works also with custom pools. \section vk_khr_external_memory_win32_exporting_win32_handle Exporting Win32 handle