Skip to content

Commit

Permalink
Added a simple compilation test and linux CI
Browse files Browse the repository at this point in the history
Compilation test is required because the smaple is windows-specific.
Linux CI is needed because pull requests must stop breaking linux builds.
  • Loading branch information
Mrkol committed Aug 28, 2024
1 parent de8e657 commit 86bacfd
Show file tree
Hide file tree
Showing 5 changed files with 99 additions and 8 deletions.
52 changes: 52 additions & 0 deletions .github/workflows/linux.yaml
Original file line number Diff line number Diff line change
@@ -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/[email protected]
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
1 change: 1 addition & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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()
36 changes: 36 additions & 0 deletions compilation_test/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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)

2 changes: 2 additions & 0 deletions compilation_test/vma_impl.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#define VMA_IMPLEMENTATION
#include <vk_mem_alloc.h>
16 changes: 8 additions & 8 deletions include/vk_mem_alloc.h
Original file line number Diff line number Diff line change
Expand Up @@ -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).
*/
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -6195,7 +6195,7 @@ class VmaWin32Handle
HANDLE m_hHandle;
VMA_RW_MUTEX m_Mutex; // Protects access m_Handle
};
#else
#else
class VmaWin32Handle
{
// ABI compatibility
Expand Down Expand Up @@ -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()
{
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 86bacfd

Please sign in to comment.