feat: windows on their own clock, deferred deletion for every handle owner, staged re-uploads, and RTPass push data
Window - updateInterval runs Update on the window's own clock while the compositor sends no frame callbacks (hidden, minimized): the Wayland loop is a poll() loop, and the Win32 loop sleeps until the next update. Both read the interval each pass. - SetPresentMode (FIFO, Mailbox, Immediate). A mode the surface lacks, or whose swapchain has other than numFrames images (Mesa's Mailbox has four), falls back to FIFO until the mode is set again. - AddPollFd / RemovePollFd wake the Wayland loop on the app's descriptors. - The swapchain has TRANSFER_DST where the surface allows it. - CaptureNextFrame replaces SaveFrame: it records the copy in the frame, before the present, where SaveFrame read an image already presented. A frame unwound past before the write still frees the readback buffer. - Inter-pass barriers on the swapchain image carry the access masks of the stages the passes use. Deferred deletion (issue #101) - VulkanBuffer, Mesh, VulkanShader, ComputeShader and PipelineRTVulkan hand their handles to the deletion queue from their destructors and moves, as a frame in flight may still use them; a static owner goes after the driver has torn down. VulkanShader and PipelineRTVulkan move and can't be copied; re-Load and re-Init queue the old pipeline. - The queue and its mutex are never destroyed, and the queue takes handles from any thread; Device::frameCounter is atomic. Both the queue and the staging rings count frames as one window renders them (documented). - DrainDeletions also lets every buffer's staging ring start over: without a Window nothing else reclaims either, so an app without one calls it after waiting for its work. Meshes and buffers - A Mesh rebuild queues the old acceleration structure and builds into the same storage after a barrier, so the BLAS address stays put when it fits. The refit and rebuild barriers cover compute ray queries too. - RTBuildOptions::noDuplicateAnyHit. Mesh::geometryFlags replaces opaque, and the refit and rebuild fallbacks keep the flags. - A re-upload into a buffer a frame in flight may read (UploadDeviceLocal of the same size, UploadDeviceLocalRange) copies on the GPU, after those reads, through a per-frame staging ring; on ReBAR it used to write the buffer in place. Empty uploads record nothing. - A compressed Mesh::Build that keeps its buffers decompresses into them after the reads of frames in flight, and the hit shaders and ray queries wait for the decompress as well as the BLAS build. Its vertex buffer takes a ranged refit's copies. - Mesh move-assigns (queueing the BLAS it replaces), so it can be replaced in place or erased from a vector. - VulkanBuffer::Create asks for a device address only for buffers with SHADER_DEVICE_ADDRESS usage, as vkGetBufferDeviceAddress requires; the others have address 0. UIRenderer::RegisterBuffer refuses those. - Build inputs are synchronized as shader reads. Other - RTPass pushes the app's own push data and traces at an explicit size. - DescriptorHeapVulkan hands freed slot ranges out again (they leaked), and keeps its free lists sorted. - ImageVulkan's mip chain clamps each level to 1 texel: a non-square image's shorter side went to 0. - VulkanShader throws on a missing file instead of failing in bad_alloc. - CRAFTER_GRAPHICS_DEVICE picks the GPU by its number among the distinct GPUs Vulkan lists; anything but such a number is an error. - The debug messenger prints info messages only with CRAFTER_GRAPHICS_VALIDATION set. - Windows: the WinRT gamepad code moved to a C file (mingw-w64's WinRT headers don't compile as C++), -lcombase dropped, a reference leak fixed. - project.cpp honours --local for Crafter.Event, Math and Asset, as Asset does for Math, and builds every test through one helper, projectArgs included. - Tests: DebugMessengerSeverity, DeletionQueueThreads, DeviceSelection, HeapSlotReuse, MeshLifetime, MipChainNonSquare, PipelineLifetime, RTPassPushData, SwapchainTransferDst, UploadInFlight, VulkanBufferAddress, VulkanShaderLifetime, WindowUpdateClock; others extended. Breaking: SaveFrame is CaptureNextFrame; Mesh::opaque is geometryFlags; a buffer without SHADER_DEVICE_ADDRESS usage has no address; frameCounter is std::atomic. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
parent
449d5da553
commit
079b6b0e1f
47 changed files with 3572 additions and 1430 deletions
121
tests/VulkanShaderLifetime/main.cpp
Normal file
121
tests/VulkanShaderLifetime/main.cpp
Normal file
|
|
@ -0,0 +1,121 @@
|
|||
//SPDX-License-Identifier: LGPL-3.0-only
|
||||
//SPDX-FileCopyrightText: Copyright (C) 2026 Catcrafts®
|
||||
|
||||
// A VulkanShader releases its shader module. It used to have no destructor,
|
||||
// so every module leaked, and ComputeShader::Load destroyed the module by
|
||||
// hand. The destructor hands the module to the deferred-deletion queue (issue
|
||||
// #101), like the other owners of Vulkan handles, so a static VulkanShader
|
||||
// makes no Vulkan call at exit. A VulkanShader can't be copied any more, since
|
||||
// two copies would both release the module; moves hand it over, which is what
|
||||
// a growing std::vector<VulkanShader> needs. A file that can't be read throws,
|
||||
// naming it: it used to print a line and create a module from no code, which
|
||||
// surfaced later as an unrelated driver error.
|
||||
//
|
||||
// Needs a Vulkan device and no window: the test steps Device::frameCounter
|
||||
// itself. The validation check only means something with
|
||||
// CRAFTER_GRAPHICS_VALIDATION set.
|
||||
|
||||
#include <cstdlib>
|
||||
#include "vulkan/vulkan.h"
|
||||
|
||||
import Crafter.Graphics;
|
||||
import std;
|
||||
|
||||
using namespace Crafter;
|
||||
namespace fs = std::filesystem;
|
||||
|
||||
namespace {
|
||||
|
||||
int failures = 0;
|
||||
|
||||
void Check(bool ok, std::string_view what) {
|
||||
std::println("{} {}", ok ? "PASS" : "FAIL", what);
|
||||
if (!ok) ++failures;
|
||||
}
|
||||
|
||||
fs::path ShaderPath() {
|
||||
return fs::read_symlink("/proc/self/exe").parent_path() / "noop.comp.spv";
|
||||
}
|
||||
|
||||
std::size_t QueuedCount(VkShaderModule module) {
|
||||
return static_cast<std::size_t>(std::ranges::count_if(Device::deletionQueue,
|
||||
[&](const Device::PendingDeletion& e) { return e.shaderModule == module; }));
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
static_assert(!std::is_copy_constructible_v<VulkanShader> && !std::is_copy_assignable_v<VulkanShader>,
|
||||
"two copies of a VulkanShader would both release its module");
|
||||
|
||||
int main() {
|
||||
Device::Initialize();
|
||||
Device::validationErrorCount = 0;
|
||||
Device::framesInFlight = Window::numFrames;
|
||||
Device::frameCounter = 0;
|
||||
Device::DrainDeletions();
|
||||
|
||||
// ── Destroying a VulkanShader queues its module ──────────────────────────
|
||||
VkShaderModule module = VK_NULL_HANDLE;
|
||||
{
|
||||
VulkanShader shader(ShaderPath(), "main", VK_SHADER_STAGE_COMPUTE_BIT, nullptr);
|
||||
module = shader.shader;
|
||||
Check(module != VK_NULL_HANDLE, "the shader module was created");
|
||||
Check(Device::deletionQueue.empty(), "a live VulkanShader has queued nothing");
|
||||
}
|
||||
Check(QueuedCount(module) == 1, "destroying a VulkanShader queues its module");
|
||||
Device::frameCounter = Window::numFrames;
|
||||
Device::ReclaimDeletions();
|
||||
Check(Device::deletionQueue.empty(), "the module is freed on its retire frame");
|
||||
|
||||
// ── Moving hands the module over ─────────────────────────────────────────
|
||||
{
|
||||
VulkanShader source(ShaderPath(), "main", VK_SHADER_STAGE_COMPUTE_BIT, nullptr);
|
||||
module = source.shader;
|
||||
VulkanShader moved(std::move(source));
|
||||
Check(source.shader == VK_NULL_HANDLE && moved.shader == module, "a move constructor hands the module over");
|
||||
|
||||
VulkanShader target(ShaderPath(), "main", VK_SHADER_STAGE_COMPUTE_BIT, nullptr);
|
||||
const VkShaderModule replaced = target.shader;
|
||||
target = std::move(moved);
|
||||
Check(moved.shader == VK_NULL_HANDLE && target.shader == module, "a move assignment hands the module over");
|
||||
Check(QueuedCount(replaced) == 1, "and queues the module it replaced");
|
||||
Check(QueuedCount(module) == 0, "the module moved around is not queued while owned");
|
||||
}
|
||||
Check(QueuedCount(module) == 1, "the module is queued once, by its last owner");
|
||||
Device::DrainDeletions();
|
||||
|
||||
// ── A growing std::vector<VulkanShader> moves its elements ───────────────
|
||||
{
|
||||
std::vector<VkShaderModule> modules;
|
||||
{
|
||||
std::vector<VulkanShader> shaders;
|
||||
for (int i = 0; i < 5; ++i) {
|
||||
shaders.emplace_back(ShaderPath(), "main", VK_SHADER_STAGE_COMPUTE_BIT, nullptr);
|
||||
}
|
||||
for (const VulkanShader& shader : shaders) modules.push_back(shader.shader);
|
||||
Check(Device::deletionQueue.empty(), "growing the vector queued nothing");
|
||||
}
|
||||
Check(std::ranges::all_of(modules, [](VkShaderModule m) { return QueuedCount(m) == 1; }),
|
||||
"each module in the vector is queued exactly once when the vector goes");
|
||||
Device::DrainDeletions();
|
||||
}
|
||||
|
||||
// ── A file that isn't there throws, naming it ─────────────────────────────
|
||||
{
|
||||
std::string message;
|
||||
try {
|
||||
VulkanShader missing(ShaderPath().parent_path() / "missing.spv", "main", VK_SHADER_STAGE_COMPUTE_BIT, nullptr);
|
||||
} catch (const std::runtime_error& e) {
|
||||
message = e.what();
|
||||
}
|
||||
Check(message.find("missing.spv") != std::string::npos,
|
||||
std::format("a shader file that isn't there throws, naming it ({})", message.empty() ? "no exception" : message));
|
||||
}
|
||||
|
||||
if (std::getenv("CRAFTER_GRAPHICS_VALIDATION") != nullptr) {
|
||||
Check(Device::validationErrorCount == 0,
|
||||
std::format("no Vulkan validation errors across the run ({} seen)", Device::validationErrorCount));
|
||||
}
|
||||
std::println("{}", failures == 0 ? "all checks passed" : "check(s) failed");
|
||||
return failures == 0 ? EXIT_SUCCESS : EXIT_FAILURE;
|
||||
}
|
||||
Loading…
Reference in a new issue