Skip to content

Commit

Permalink
vulkan layout hash collision handling (#1048)
Browse files Browse the repository at this point in the history
  • Loading branch information
@turanszkij
turanszkij authored Jan 30, 2025
1 parent 45b2ff3 commit ed5b4a0
Show file tree
Hide file tree
Showing 3 changed files with 133 additions and 66 deletions.
113 changes: 54 additions & 59 deletions WickedEngine/wiGraphicsDevice_Vulkan.cpp
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
#include "wiGraphicsDevice_Vulkan.h"

#ifdef WICKEDENGINE_BUILD_VULKAN
#include "wiHelper.h"
#include "wiVersion.h"
#include "wiTimer.h"
#include "wiUnorderedSet.h"
Expand Down Expand Up @@ -901,8 +900,6 @@ namespace vulkan_internal
VkDeviceSize uniform_buffer_sizes[DESCRIPTORBINDER_CBV_COUNT] = {};
wi::vector<uint32_t> uniform_buffer_dynamic_slots;

size_t binding_hash = 0;

~Shader_Vulkan()
{
if (allocationhandler == nullptr)
Expand Down Expand Up @@ -932,8 +929,6 @@ namespace vulkan_internal
VkDeviceSize uniform_buffer_sizes[DESCRIPTORBINDER_CBV_COUNT] = {};
wi::vector<uint32_t> uniform_buffer_dynamic_slots;

size_t binding_hash = 0;

VkGraphicsPipelineCreateInfo pipelineInfo = {};
VkPipelineShaderStageCreateInfo shaderStages[static_cast<size_t>(ShaderStage::Count)] = {};
VkPipelineInputAssemblyStateCreateInfo inputAssembly = {};
Expand Down Expand Up @@ -2129,7 +2124,7 @@ using namespace vulkan_internal;
return;

const PipelineState* pso = commandlist.active_pso;
PipelineHash pipeline_hash = commandlist.prev_pipeline_hash;
const PipelineHash& pipeline_hash = commandlist.prev_pipeline_hash;
auto internal_state = to_internal(pso);

VkPipeline pipeline = VK_NULL_HANDLE;
Expand Down Expand Up @@ -4768,30 +4763,25 @@ using namespace vulkan_internal;

if (stage == ShaderStage::CS || stage == ShaderStage::LIB)
{
internal_state->binding_hash = 0;
PSOLayoutHash layout_hasher;
size_t i = 0;
for (auto& x : internal_state->layoutBindings)
{
wi::helper::hash_combine(internal_state->binding_hash, x.binding);
wi::helper::hash_combine(internal_state->binding_hash, x.descriptorCount);
wi::helper::hash_combine(internal_state->binding_hash, x.descriptorType);
wi::helper::hash_combine(internal_state->binding_hash, x.stageFlags);
wi::helper::hash_combine(internal_state->binding_hash, internal_state->imageViewTypes[i++]);
auto& item = layout_hasher.items.emplace_back();
item.binding = x;
item.viewType = internal_state->imageViewTypes[i++];
}
for (auto& x : internal_state->bindlessBindings)
{
wi::helper::hash_combine(internal_state->binding_hash, x.used);
wi::helper::hash_combine(internal_state->binding_hash, x.binding.binding);
wi::helper::hash_combine(internal_state->binding_hash, x.binding.descriptorCount);
wi::helper::hash_combine(internal_state->binding_hash, x.binding.descriptorType);
wi::helper::hash_combine(internal_state->binding_hash, x.binding.stageFlags);
auto& item = layout_hasher.items.emplace_back();
item.binding = x.binding;
item.used = x.used;
}
wi::helper::hash_combine(internal_state->binding_hash, internal_state->pushconstants.offset);
wi::helper::hash_combine(internal_state->binding_hash, internal_state->pushconstants.size);
wi::helper::hash_combine(internal_state->binding_hash, internal_state->pushconstants.stageFlags);
layout_hasher.push = internal_state->pushconstants;
layout_hasher.embed_hash();

pso_layout_cache_mutex.lock();
if (pso_layout_cache[internal_state->binding_hash].pipelineLayout == VK_NULL_HANDLE)
if (pso_layout_cache[layout_hasher].pipelineLayout == VK_NULL_HANDLE)
{
wi::vector<VkDescriptorSetLayout> layouts;

Expand Down Expand Up @@ -4863,18 +4853,20 @@ using namespace vulkan_internal;
res = vulkan_check(vkCreatePipelineLayout(device, &pipelineLayoutInfo, nullptr, &internal_state->pipelineLayout_cs));
if (res == VK_SUCCESS)
{
pso_layout_cache[internal_state->binding_hash].descriptorSetLayout = internal_state->descriptorSetLayout;
pso_layout_cache[internal_state->binding_hash].pipelineLayout = internal_state->pipelineLayout_cs;
pso_layout_cache[internal_state->binding_hash].bindlessSets = internal_state->bindlessSets;
pso_layout_cache[internal_state->binding_hash].bindlessFirstSet = internal_state->bindlessFirstSet;
auto& cached_layout = pso_layout_cache[layout_hasher];
cached_layout.descriptorSetLayout = internal_state->descriptorSetLayout;
cached_layout.pipelineLayout = internal_state->pipelineLayout_cs;
cached_layout.bindlessSets = internal_state->bindlessSets;
cached_layout.bindlessFirstSet = internal_state->bindlessFirstSet;
}
}
else
{
internal_state->descriptorSetLayout = pso_layout_cache[internal_state->binding_hash].descriptorSetLayout;
internal_state->pipelineLayout_cs = pso_layout_cache[internal_state->binding_hash].pipelineLayout;
internal_state->bindlessSets = pso_layout_cache[internal_state->binding_hash].bindlessSets;
internal_state->bindlessFirstSet = pso_layout_cache[internal_state->binding_hash].bindlessFirstSet;
auto& cached_layout = pso_layout_cache[layout_hasher];
internal_state->descriptorSetLayout = cached_layout.descriptorSetLayout;
internal_state->pipelineLayout_cs = cached_layout.pipelineLayout;
internal_state->bindlessSets = cached_layout.bindlessSets;
internal_state->bindlessFirstSet = cached_layout.bindlessFirstSet;
}
pso_layout_cache_mutex.unlock();
}
Expand Down Expand Up @@ -5271,31 +5263,25 @@ using namespace vulkan_internal;
insert_shader_bindless(desc->gs);
insert_shader_bindless(desc->ps);

internal_state->binding_hash = 0;
PSOLayoutHash layout_hasher;
size_t i = 0;
for (auto& x : internal_state->layoutBindings)
{
wi::helper::hash_combine(internal_state->binding_hash, x.binding);
wi::helper::hash_combine(internal_state->binding_hash, x.descriptorCount);
wi::helper::hash_combine(internal_state->binding_hash, x.descriptorType);
wi::helper::hash_combine(internal_state->binding_hash, x.stageFlags);
wi::helper::hash_combine(internal_state->binding_hash, internal_state->imageViewTypes[i++]);
auto& item = layout_hasher.items.emplace_back();
item.binding = x;
item.viewType = internal_state->imageViewTypes[i++];
}
for (auto& x : internal_state->bindlessBindings)
{
wi::helper::hash_combine(internal_state->binding_hash, x.used);
wi::helper::hash_combine(internal_state->binding_hash, x.binding.binding);
wi::helper::hash_combine(internal_state->binding_hash, x.binding.descriptorCount);
wi::helper::hash_combine(internal_state->binding_hash, x.binding.descriptorType);
wi::helper::hash_combine(internal_state->binding_hash, x.binding.stageFlags);
auto& item = layout_hasher.items.emplace_back();
item.binding = x.binding;
item.used = x.used;
}
wi::helper::hash_combine(internal_state->binding_hash, internal_state->pushconstants.offset);
wi::helper::hash_combine(internal_state->binding_hash, internal_state->pushconstants.size);
wi::helper::hash_combine(internal_state->binding_hash, internal_state->pushconstants.stageFlags);

layout_hasher.push = internal_state->pushconstants;
layout_hasher.embed_hash();

pso_layout_cache_mutex.lock();
if (pso_layout_cache[internal_state->binding_hash].pipelineLayout == VK_NULL_HANDLE)
if (pso_layout_cache[layout_hasher].pipelineLayout == VK_NULL_HANDLE)
{
wi::vector<VkDescriptorSetLayout> layouts;
{
Expand Down Expand Up @@ -5367,18 +5353,20 @@ using namespace vulkan_internal;
res = vulkan_check(vkCreatePipelineLayout(device, &pipelineLayoutInfo, nullptr, &internal_state->pipelineLayout));
if (res == VK_SUCCESS)
{
pso_layout_cache[internal_state->binding_hash].descriptorSetLayout = internal_state->descriptorSetLayout;
pso_layout_cache[internal_state->binding_hash].pipelineLayout = internal_state->pipelineLayout;
pso_layout_cache[internal_state->binding_hash].bindlessSets = internal_state->bindlessSets;
pso_layout_cache[internal_state->binding_hash].bindlessFirstSet = internal_state->bindlessFirstSet;
auto& cached_layout = pso_layout_cache[layout_hasher];
cached_layout.descriptorSetLayout = internal_state->descriptorSetLayout;
cached_layout.pipelineLayout = internal_state->pipelineLayout;
cached_layout.bindlessSets = internal_state->bindlessSets;
cached_layout.bindlessFirstSet = internal_state->bindlessFirstSet;
}
}
else
{
internal_state->descriptorSetLayout = pso_layout_cache[internal_state->binding_hash].descriptorSetLayout;
internal_state->pipelineLayout = pso_layout_cache[internal_state->binding_hash].pipelineLayout;
internal_state->bindlessSets = pso_layout_cache[internal_state->binding_hash].bindlessSets;
internal_state->bindlessFirstSet = pso_layout_cache[internal_state->binding_hash].bindlessFirstSet;
auto& cached_layout = pso_layout_cache[layout_hasher];
internal_state->descriptorSetLayout = cached_layout.descriptorSetLayout;
internal_state->pipelineLayout = cached_layout.pipelineLayout;
internal_state->bindlessSets = cached_layout.bindlessSets;
internal_state->bindlessFirstSet = cached_layout.bindlessFirstSet;
}
pso_layout_cache_mutex.unlock();
}
Expand Down Expand Up @@ -7500,9 +7488,19 @@ using namespace vulkan_internal;

// Queue command:
{
if (!queues[queue].sparse_binding_supported)
{
// 1.) fall back to graphics queue if current one doesn't support sparse, might be better than crashing
queue = QUEUE_GRAPHICS;
}
if (!queues[queue].sparse_binding_supported)
{
// 2.) fall back to compute queue if current one doesn't support sparse, might be better than crashing
queue = QUEUE_COMPUTE;
}
CommandQueue& q = queues[queue];
std::scoped_lock lock(*q.locker);
assert(q.sparse_binding_supported);
wilog_assert(q.sparse_binding_supported, "Vulkan QUEUE_TYPE=%d doesn't report sparse binding support!", int(queue));

vulkan_check(vkQueueBindSparse(q.queue, (uint32_t)sparse_infos.size(), sparse_infos.data(), VK_NULL_HANDLE));
}
Expand Down Expand Up @@ -8013,16 +8011,13 @@ using namespace vulkan_internal;
void GraphicsDevice_Vulkan::BindVertexBuffers(const GPUBuffer *const* vertexBuffers, uint32_t slot, uint32_t count, const uint32_t* strides, const uint64_t* offsets, CommandList cmd)
{
CommandList_Vulkan& commandlist = GetCommandList(cmd);
size_t hash = 0;

VkDeviceSize voffsets[8] = {};
VkDeviceSize vstrides[8] = {};
VkBuffer vbuffers[8] = {};
assert(count <= 8);
for (uint32_t i = 0; i < count; ++i)
{
wi::helper::hash_combine(hash, strides[i]);

if (vertexBuffers[i] == nullptr || !vertexBuffers[i]->IsValid())
{
vbuffers[i] = nullBuffer;
Expand Down Expand Up @@ -8180,7 +8175,7 @@ using namespace vulkan_internal;
else
{
auto active_internal = to_internal(commandlist.active_pso);
if (internal_state->binding_hash != active_internal->binding_hash)
if (internal_state->pipelineLayout != active_internal->pipelineLayout)
{
commandlist.binder.dirty |= DescriptorBinder::DIRTY_ALL;
}
Expand Down Expand Up @@ -8222,7 +8217,7 @@ using namespace vulkan_internal;
{
auto internal_state = to_internal(cs);
auto active_internal = to_internal(commandlist.active_cs);
if (internal_state->binding_hash != active_internal->binding_hash)
if (internal_state->pipelineLayout_cs != active_internal->pipelineLayout_cs)
{
commandlist.binder.dirty |= DescriptorBinder::DIRTY_ALL;
}
Expand Down
84 changes: 78 additions & 6 deletions WickedEngine/wiGraphicsDevice_Vulkan.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
#include "wiVector.h"
#include "wiSpinLock.h"
#include "wiBacklog.h"
#include "wiHelper.h"

#ifdef _WIN32
#define VK_USE_PLATFORM_WIN32_KHR
Expand All @@ -31,6 +32,80 @@
#define vulkan_assert(cond, fname) { wilog_assert(cond, "Vulkan error: %s failed with %s (%s:%d)", fname, string_VkResult(res), relative_path(__FILE__), __LINE__); }
#define vulkan_check(call) [&]() { VkResult res = call; vulkan_assert((res == VK_SUCCESS), extract_function_name(#call).c_str()); return res; }()

namespace wi::graphics
{
struct PSOLayoutHash
{
VkPushConstantRange push = {};
struct Item
{
bool used = true;
VkImageViewType viewType = VK_IMAGE_VIEW_TYPE_2D;
VkDescriptorSetLayoutBinding binding = {};
};
wi::vector<Item> items;
size_t hash = 0;

inline bool operator==(const PSOLayoutHash& other) const
{
if (hash != other.hash)
return false;
if (items.size() != other.items.size())
return false;
for (size_t i = 0; i < items.size(); ++i)
{
const Item& a = items[i];
const Item& b = other.items[i];
if (
a.used != b.used ||
a.viewType != b.viewType ||
a.binding.binding != b.binding.binding ||
a.binding.descriptorCount != b.binding.descriptorCount ||
a.binding.descriptorType != b.binding.descriptorType ||
a.binding.stageFlags != b.binding.stageFlags ||
a.binding.pImmutableSamplers != b.binding.pImmutableSamplers
)
return false;
}
return
push.offset == other.push.offset &&
push.size == other.push.size &&
push.stageFlags == other.push.stageFlags;
}
inline void embed_hash()
{
hash = 0;
for (auto& x : items)
{
wi::helper::hash_combine(hash, x.used);
wi::helper::hash_combine(hash, x.viewType);
wi::helper::hash_combine(hash, x.binding.binding);
wi::helper::hash_combine(hash, x.binding.descriptorCount);
wi::helper::hash_combine(hash, x.binding.descriptorType);
wi::helper::hash_combine(hash, x.binding.stageFlags);
}
wi::helper::hash_combine(hash, push.offset);
wi::helper::hash_combine(hash, push.size);
wi::helper::hash_combine(hash, push.stageFlags);
}
constexpr size_t get_hash() const
{
return hash;
}
};
}
namespace std
{
template <>
struct hash<wi::graphics::PSOLayoutHash>
{
constexpr size_t operator()(const wi::graphics::PSOLayoutHash& hash) const
{
return hash.get_hash();
}
};
}

namespace wi::graphics
{
class GraphicsDevice_Vulkan final : public GraphicsDevice
Expand Down Expand Up @@ -146,7 +221,7 @@ namespace wi::graphics
VkFence fence = VK_NULL_HANDLE;
VkSemaphore semaphores[3] = { VK_NULL_HANDLE, VK_NULL_HANDLE, VK_NULL_HANDLE }; // graphics, compute, video
GPUBuffer uploadbuffer;
inline bool IsValid() const { return transferCommandBuffer != VK_NULL_HANDLE; }
constexpr bool IsValid() const { return transferCommandBuffer != VK_NULL_HANDLE; }
};
wi::vector<CopyCMD> freelist;

Expand Down Expand Up @@ -303,7 +378,7 @@ namespace wi::graphics
wi::vector<VkDescriptorSet> bindlessSets;
uint32_t bindlessFirstSet = 0;
};
mutable wi::unordered_map<size_t, PSOLayout> pso_layout_cache;
mutable wi::unordered_map<PSOLayoutHash, PSOLayout> pso_layout_cache;
mutable std::mutex pso_layout_cache_mutex;

VkPipelineCache pipelineCache = VK_NULL_HANDLE;
Expand Down Expand Up @@ -714,7 +789,7 @@ namespace wi::graphics

framecount = FRAMECOUNT;

destroylocker.lock();
std::scoped_lock lck(destroylocker);

destroy(destroyer_allocations, [&](auto& item) {
vmaFreeMemory(allocator, item);
Expand Down Expand Up @@ -794,12 +869,9 @@ namespace wi::graphics
destroy(destroyer_bindlessAccelerationStructures, [&](auto& item) {
bindlessAccelerationStructures.free(item);
});

destroylocker.unlock();
}
};
std::shared_ptr<AllocationHandler> allocationhandler;

};
}

Expand Down
2 changes: 1 addition & 1 deletion WickedEngine/wiVersion.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace wi::version
// minor features, major updates, breaking compatibility changes
const int minor = 71;
// minor bug fixes, alterations, refactors, updates
const int revision = 667;
const int revision = 668;

const std::string version_string = std::to_string(major) + "." + std::to_string(minor) + "." + std::to_string(revision);

Expand Down

0 comments on commit ed5b4a0

Please sign in to comment.