eden-emu/Vulkan-Utility-Libraries
15
0
Fork 0
mirror of https://github.com/KhronosGroup/Vulkan-Utility-Libraries.git synced 2025-05-24 21:49:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

safestruct: Accessors for non trivial globals

Browse source 
Adding Tracy in VVL showed that we are paying the price of initializing
global variables upon shared library entry, even if we do not
end up accessing those.
Adding accessors will make sure we pay this price
only when truly needed.
Also making the necessary changes in VVL.
This commit is contained in:
Arno 2024-07-17 16:02:41 +02:00 • committed by Charles Giessen
parent 5f26cf65a1
commit 9479047902
5 changed files with 44 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

4
include/vulkan/utility/vk_safe_struct.hpp
View file

@ -22,6 +22,10 @@
namespace vku { namespace vku {
// Mapping of unknown stype codes to structure lengths. This should be set up by the application
// before vkCreateInstance() and not modified afterwards.
std::vector<std::pair<uint32_t, uint32_t>>& GetCustomStypeInfo();
struct safe_VkBufferMemoryBarrier { struct safe_VkBufferMemoryBarrier {
VkStructureType sType; VkStructureType sType;
const void* pNext{}; const void* pNext{};

4
include/vulkan/utility/vk_safe_struct_utils.hpp
View file

@ -19,10 +19,6 @@
namespace vku { namespace vku {
// Mapping of unknown stype codes to structure lengths. This should be set up by the application
// before vkCreateInstance() and not modified afterwards.
extern std::vector<std::pair<uint32_t, uint32_t>> custom_stype_info;
// State that elements in a pNext chain may need to be aware of // State that elements in a pNext chain may need to be aware of
struct PNextCopyState { struct PNextCopyState {
// Custom initialization function. Returns true if the structure passed to init was initialized, false otherwise // Custom initialization function. Returns true if the structure passed to init was initialized, false otherwise

10
scripts/generators/safe_struct_generator.py
View file

@ -159,6 +159,10 @@ class SafeStructOutputGenerator(BaseGenerator):
#include <vulkan/utility/vk_safe_struct_utils.hpp> #include <vulkan/utility/vk_safe_struct_utils.hpp>
namespace vku { namespace vku {
// Mapping of unknown stype codes to structure lengths. This should be set up by the application
// before vkCreateInstance() and not modified afterwards.
std::vector<std::pair<uint32_t, uint32_t>>& GetCustomStypeInfo();
\n''') \n''')
guard_helper = PlatformGuardHelper() guard_helper = PlatformGuardHelper()
@ -251,8 +255,6 @@ class SafeStructOutputGenerator(BaseGenerator):
#include <vector> #include <vector>
#include <cstring> #include <cstring>
extern std::vector<std::pair<uint32_t, uint32_t>> custom_stype_info;
namespace vku { namespace vku {
char *SafeStringCopy(const char *in_string) { char *SafeStringCopy(const char *in_string) {
if (nullptr == in_string) return nullptr; if (nullptr == in_string) return nullptr;
@ -305,7 +307,7 @@ void *SafePnextCopy(const void *pNext, PNextCopyState* copy_state) {
out.append(''' out.append('''
default: // Encountered an unknown sType -- skip (do not copy) this entry in the chain default: // Encountered an unknown sType -- skip (do not copy) this entry in the chain
// If sType is in custom list, construct blind copy // If sType is in custom list, construct blind copy
for (auto item : custom_stype_info) { for (auto item : GetCustomStypeInfo()) {
if (item.first == static_cast<uint32_t>(header->sType)) { if (item.first == static_cast<uint32_t>(header->sType)) {
safe_pNext = malloc(item.second); safe_pNext = malloc(item.second);
memcpy(safe_pNext, header, item.second); memcpy(safe_pNext, header, item.second);
@ -361,7 +363,7 @@ void FreePnextChain(const void *pNext) {
out.append(''' out.append('''
default: // Encountered an unknown sType default: // Encountered an unknown sType
// If sType is in custom list, free custom struct memory and clean up // If sType is in custom list, free custom struct memory and clean up
for (auto item : custom_stype_info) { for (auto item : GetCustomStypeInfo() ) {
if (item.first == static_cast<uint32_t>(header->sType)) { if (item.first == static_cast<uint32_t>(header->sType)) {
free(current); free(current);
break; break;

56
src/vulkan/vk_safe_struct_manual.cpp
View file

@ -18,7 +18,10 @@
namespace vku { namespace vku {
std::vector<std::pair<uint32_t, uint32_t>> custom_stype_info{}; std::vector<std::pair<uint32_t, uint32_t>>& GetCustomStypeInfo() {
static std::vector<std::pair<uint32_t, uint32_t>> custom_stype_info{};
return custom_stype_info;
}
struct ASGeomKHRExtraData { struct ASGeomKHRExtraData {
ASGeomKHRExtraData(uint8_t* alloc, uint32_t primOffset, uint32_t primCount) ASGeomKHRExtraData(uint8_t* alloc, uint32_t primOffset, uint32_t primCount)
@ -31,7 +34,12 @@ struct ASGeomKHRExtraData {
uint32_t primitiveCount; uint32_t primitiveCount;
}; };
vku::concurrent::unordered_map<const safe_VkAccelerationStructureGeometryKHR*, ASGeomKHRExtraData*, 4> as_geom_khr_host_alloc; vku::concurrent::unordered_map<const safe_VkAccelerationStructureGeometryKHR*, ASGeomKHRExtraData*, 4>&
GetAccelStructGeomHostAllocMap() {
static vku::concurrent::unordered_map<const safe_VkAccelerationStructureGeometryKHR*, ASGeomKHRExtraData*, 4>
as_geom_khr_host_alloc;
return as_geom_khr_host_alloc;
}
safe_VkAccelerationStructureGeometryKHR::safe_VkAccelerationStructureGeometryKHR( safe_VkAccelerationStructureGeometryKHR::safe_VkAccelerationStructureGeometryKHR(
const VkAccelerationStructureGeometryKHR* in_struct, const bool is_host, const VkAccelerationStructureGeometryKHR* in_struct, const bool is_host,
@ -57,7 +65,7 @@ safe_VkAccelerationStructureGeometryKHR::safe_VkAccelerationStructureGeometryKHR
ppInstances[i] = &pInstances[i]; ppInstances[i] = &pInstances[i];
} }
geometry.instances.data.hostAddress = allocation; geometry.instances.data.hostAddress = allocation;
as_geom_khr_host_alloc.insert( GetAccelStructGeomHostAllocMap().insert(
this, new ASGeomKHRExtraData(allocation, build_range_info->primitiveOffset, build_range_info->primitiveCount)); this, new ASGeomKHRExtraData(allocation, build_range_info->primitiveOffset, build_range_info->primitiveCount));
} else { } else {
const auto primitive_offset = build_range_info->primitiveOffset; const auto primitive_offset = build_range_info->primitiveOffset;
@ -68,7 +76,7 @@ safe_VkAccelerationStructureGeometryKHR::safe_VkAccelerationStructureGeometryKHR
memcpy(allocation + primitive_offset, host_address + primitive_offset, memcpy(allocation + primitive_offset, host_address + primitive_offset,
primitive_count * sizeof(VkAccelerationStructureInstanceKHR)); primitive_count * sizeof(VkAccelerationStructureInstanceKHR));
geometry.instances.data.hostAddress = allocation; geometry.instances.data.hostAddress = allocation;
as_geom_khr_host_alloc.insert( GetAccelStructGeomHostAllocMap().insert(
this, new ASGeomKHRExtraData(allocation, build_range_info->primitiveOffset, build_range_info->primitiveCount)); this, new ASGeomKHRExtraData(allocation, build_range_info->primitiveOffset, build_range_info->primitiveCount));
} }
} }
@ -85,8 +93,8 @@ safe_VkAccelerationStructureGeometryKHR::safe_VkAccelerationStructureGeometryKHR
flags = copy_src.flags; flags = copy_src.flags;
pNext = SafePnextCopy(copy_src.pNext); pNext = SafePnextCopy(copy_src.pNext);
auto src_iter = as_geom_khr_host_alloc.find(&copy_src); auto src_iter = GetAccelStructGeomHostAllocMap().find(&copy_src);
if (src_iter != as_geom_khr_host_alloc.end()) { if (src_iter != GetAccelStructGeomHostAllocMap().end()) {
auto& src_alloc = src_iter->second; auto& src_alloc = src_iter->second;
if (geometry.instances.arrayOfPointers) { if (geometry.instances.arrayOfPointers) {
size_t pp_array_size = src_alloc->primitiveCount * sizeof(VkAccelerationStructureInstanceKHR*); size_t pp_array_size = src_alloc->primitiveCount * sizeof(VkAccelerationStructureInstanceKHR*);
@ -103,14 +111,14 @@ safe_VkAccelerationStructureGeometryKHR::safe_VkAccelerationStructureGeometryKHR
ppInstances[i] = &pInstances[i]; ppInstances[i] = &pInstances[i];
} }
geometry.instances.data.hostAddress = allocation; geometry.instances.data.hostAddress = allocation;
as_geom_khr_host_alloc.insert( GetAccelStructGeomHostAllocMap().insert(
this, new ASGeomKHRExtraData(allocation, src_alloc->primitiveOffset, src_alloc->primitiveCount)); this, new ASGeomKHRExtraData(allocation, src_alloc->primitiveOffset, src_alloc->primitiveCount));
} else { } else {
size_t array_size = src_alloc->primitiveOffset + src_alloc->primitiveCount * sizeof(VkAccelerationStructureInstanceKHR); size_t array_size = src_alloc->primitiveOffset + src_alloc->primitiveCount * sizeof(VkAccelerationStructureInstanceKHR);
uint8_t* allocation = new uint8_t[array_size]; uint8_t* allocation = new uint8_t[array_size];
memcpy(allocation, src_alloc->ptr, array_size); memcpy(allocation, src_alloc->ptr, array_size);
geometry.instances.data.hostAddress = allocation; geometry.instances.data.hostAddress = allocation;
as_geom_khr_host_alloc.insert( GetAccelStructGeomHostAllocMap().insert(
this, new ASGeomKHRExtraData(allocation, src_alloc->primitiveOffset, src_alloc->primitiveCount)); this, new ASGeomKHRExtraData(allocation, src_alloc->primitiveOffset, src_alloc->primitiveCount));
} }
} }
@ -120,8 +128,8 @@ safe_VkAccelerationStructureGeometryKHR& safe_VkAccelerationStructureGeometryKHR
const safe_VkAccelerationStructureGeometryKHR& copy_src) { const safe_VkAccelerationStructureGeometryKHR& copy_src) {
if (&copy_src == this) return *this; if (&copy_src == this) return *this;
auto iter = as_geom_khr_host_alloc.pop(this); auto iter = GetAccelStructGeomHostAllocMap().pop(this);
if (iter != as_geom_khr_host_alloc.end()) { if (iter != GetAccelStructGeomHostAllocMap().end()) {
delete iter->second; delete iter->second;
} }
FreePnextChain(pNext); FreePnextChain(pNext);
@ -132,8 +140,8 @@ safe_VkAccelerationStructureGeometryKHR& safe_VkAccelerationStructureGeometryKHR
flags = copy_src.flags; flags = copy_src.flags;
pNext = SafePnextCopy(copy_src.pNext); pNext = SafePnextCopy(copy_src.pNext);
auto src_iter = as_geom_khr_host_alloc.find(&copy_src); auto src_iter = GetAccelStructGeomHostAllocMap().find(&copy_src);
if (src_iter != as_geom_khr_host_alloc.end()) { if (src_iter != GetAccelStructGeomHostAllocMap().end()) {
auto& src_alloc = src_iter->second; auto& src_alloc = src_iter->second;
if (geometry.instances.arrayOfPointers) { if (geometry.instances.arrayOfPointers) {
size_t pp_array_size = src_alloc->primitiveCount * sizeof(VkAccelerationStructureInstanceKHR*); size_t pp_array_size = src_alloc->primitiveCount * sizeof(VkAccelerationStructureInstanceKHR*);
@ -150,14 +158,14 @@ safe_VkAccelerationStructureGeometryKHR& safe_VkAccelerationStructureGeometryKHR
ppInstances[i] = &pInstances[i]; ppInstances[i] = &pInstances[i];
} }
geometry.instances.data.hostAddress = allocation; geometry.instances.data.hostAddress = allocation;
as_geom_khr_host_alloc.insert( GetAccelStructGeomHostAllocMap().insert(
this, new ASGeomKHRExtraData(allocation, src_alloc->primitiveOffset, src_alloc->primitiveCount)); this, new ASGeomKHRExtraData(allocation, src_alloc->primitiveOffset, src_alloc->primitiveCount));
} else { } else {
size_t array_size = src_alloc->primitiveOffset + src_alloc->primitiveCount * sizeof(VkAccelerationStructureInstanceKHR); size_t array_size = src_alloc->primitiveOffset + src_alloc->primitiveCount * sizeof(VkAccelerationStructureInstanceKHR);
uint8_t* allocation = new uint8_t[array_size]; uint8_t* allocation = new uint8_t[array_size];
memcpy(allocation, src_alloc->ptr, array_size); memcpy(allocation, src_alloc->ptr, array_size);
geometry.instances.data.hostAddress = allocation; geometry.instances.data.hostAddress = allocation;
as_geom_khr_host_alloc.insert( GetAccelStructGeomHostAllocMap().insert(
this, new ASGeomKHRExtraData(allocation, src_alloc->primitiveOffset, src_alloc->primitiveCount)); this, new ASGeomKHRExtraData(allocation, src_alloc->primitiveOffset, src_alloc->primitiveCount));
} }
} }
@ -166,8 +174,8 @@ safe_VkAccelerationStructureGeometryKHR& safe_VkAccelerationStructureGeometryKHR
} }
safe_VkAccelerationStructureGeometryKHR::~safe_VkAccelerationStructureGeometryKHR() { safe_VkAccelerationStructureGeometryKHR::~safe_VkAccelerationStructureGeometryKHR() {
auto iter = as_geom_khr_host_alloc.pop(this); auto iter = GetAccelStructGeomHostAllocMap().pop(this);
if (iter != as_geom_khr_host_alloc.end()) { if (iter != GetAccelStructGeomHostAllocMap().end()) {
delete iter->second; delete iter->second;
} }
FreePnextChain(pNext); FreePnextChain(pNext);
@ -176,8 +184,8 @@ safe_VkAccelerationStructureGeometryKHR::~safe_VkAccelerationStructureGeometryKH
void safe_VkAccelerationStructureGeometryKHR::initialize(const VkAccelerationStructureGeometryKHR* in_struct, const bool is_host, void safe_VkAccelerationStructureGeometryKHR::initialize(const VkAccelerationStructureGeometryKHR* in_struct, const bool is_host,
const VkAccelerationStructureBuildRangeInfoKHR* build_range_info, const VkAccelerationStructureBuildRangeInfoKHR* build_range_info,
[[maybe_unused]] PNextCopyState* copy_state) { [[maybe_unused]] PNextCopyState* copy_state) {
auto iter = as_geom_khr_host_alloc.pop(this); auto iter = GetAccelStructGeomHostAllocMap().pop(this);
if (iter != as_geom_khr_host_alloc.end()) { if (iter != GetAccelStructGeomHostAllocMap().end()) {
delete iter->second; delete iter->second;
} }
FreePnextChain(pNext); FreePnextChain(pNext);
@ -204,7 +212,7 @@ void safe_VkAccelerationStructureGeometryKHR::initialize(const VkAccelerationStr
ppInstances[i] = &pInstances[i]; ppInstances[i] = &pInstances[i];
} }
geometry.instances.data.hostAddress = allocation; geometry.instances.data.hostAddress = allocation;
as_geom_khr_host_alloc.insert( GetAccelStructGeomHostAllocMap().insert(
this, new ASGeomKHRExtraData(allocation, build_range_info->primitiveOffset, build_range_info->primitiveCount)); this, new ASGeomKHRExtraData(allocation, build_range_info->primitiveOffset, build_range_info->primitiveCount));
} else { } else {
const auto primitive_offset = build_range_info->primitiveOffset; const auto primitive_offset = build_range_info->primitiveOffset;
@ -215,7 +223,7 @@ void safe_VkAccelerationStructureGeometryKHR::initialize(const VkAccelerationStr
memcpy(allocation + primitive_offset, host_address + primitive_offset, memcpy(allocation + primitive_offset, host_address + primitive_offset,
primitive_count * sizeof(VkAccelerationStructureInstanceKHR)); primitive_count * sizeof(VkAccelerationStructureInstanceKHR));
geometry.instances.data.hostAddress = allocation; geometry.instances.data.hostAddress = allocation;
as_geom_khr_host_alloc.insert( GetAccelStructGeomHostAllocMap().insert(
this, new ASGeomKHRExtraData(allocation, build_range_info->primitiveOffset, build_range_info->primitiveCount)); this, new ASGeomKHRExtraData(allocation, build_range_info->primitiveOffset, build_range_info->primitiveCount));
} }
} }
@ -229,8 +237,8 @@ void safe_VkAccelerationStructureGeometryKHR::initialize(const safe_VkAccelerati
flags = copy_src->flags; flags = copy_src->flags;
pNext = SafePnextCopy(copy_src->pNext); pNext = SafePnextCopy(copy_src->pNext);
auto src_iter = as_geom_khr_host_alloc.find(copy_src); auto src_iter = GetAccelStructGeomHostAllocMap().find(copy_src);
if (src_iter != as_geom_khr_host_alloc.end()) { if (src_iter != GetAccelStructGeomHostAllocMap().end()) {
auto& src_alloc = src_iter->second; auto& src_alloc = src_iter->second;
if (geometry.instances.arrayOfPointers) { if (geometry.instances.arrayOfPointers) {
size_t pp_array_size = src_alloc->primitiveCount * sizeof(VkAccelerationStructureInstanceKHR*); size_t pp_array_size = src_alloc->primitiveCount * sizeof(VkAccelerationStructureInstanceKHR*);
@ -247,14 +255,14 @@ void safe_VkAccelerationStructureGeometryKHR::initialize(const safe_VkAccelerati
ppInstances[i] = &pInstances[i]; ppInstances[i] = &pInstances[i];
} }
geometry.instances.data.hostAddress = allocation; geometry.instances.data.hostAddress = allocation;
as_geom_khr_host_alloc.insert( GetAccelStructGeomHostAllocMap().insert(
this, new ASGeomKHRExtraData(allocation, src_alloc->primitiveOffset, src_alloc->primitiveCount)); this, new ASGeomKHRExtraData(allocation, src_alloc->primitiveOffset, src_alloc->primitiveCount));
} else { } else {
size_t array_size = src_alloc->primitiveOffset + src_alloc->primitiveCount * sizeof(VkAccelerationStructureInstanceKHR); size_t array_size = src_alloc->primitiveOffset + src_alloc->primitiveCount * sizeof(VkAccelerationStructureInstanceKHR);
uint8_t* allocation = new uint8_t[array_size]; uint8_t* allocation = new uint8_t[array_size];
memcpy(allocation, src_alloc->ptr, array_size); memcpy(allocation, src_alloc->ptr, array_size);
geometry.instances.data.hostAddress = allocation; geometry.instances.data.hostAddress = allocation;
as_geom_khr_host_alloc.insert( GetAccelStructGeomHostAllocMap().insert(
this, new ASGeomKHRExtraData(allocation, src_alloc->primitiveOffset, src_alloc->primitiveCount)); this, new ASGeomKHRExtraData(allocation, src_alloc->primitiveOffset, src_alloc->primitiveCount));
} }
} }

6
src/vulkan/vk_safe_struct_utils.cpp
View file

@ -20,8 +20,6 @@
#include <vector> #include <vector>
#include <cstring> #include <cstring>
extern std::vector<std::pair<uint32_t, uint32_t>> custom_stype_info;
namespace vku { namespace vku {
char *SafeStringCopy(const char *in_string) { char *SafeStringCopy(const char *in_string) {
if (nullptr == in_string) return nullptr; if (nullptr == in_string) return nullptr;
@ -1848,7 +1846,7 @@ void *SafePnextCopy(const void *pNext, PNextCopyState* copy_state) {
default: // Encountered an unknown sType -- skip (do not copy) this entry in the chain default: // Encountered an unknown sType -- skip (do not copy) this entry in the chain
// If sType is in custom list, construct blind copy // If sType is in custom list, construct blind copy
for (auto item : custom_stype_info) { for (auto item : GetCustomStypeInfo()) {
if (item.first == static_cast<uint32_t>(header->sType)) { if (item.first == static_cast<uint32_t>(header->sType)) {
safe_pNext = malloc(item.second); safe_pNext = malloc(item.second);
memcpy(safe_pNext, header, item.second); memcpy(safe_pNext, header, item.second);
@ -3680,7 +3678,7 @@ void FreePnextChain(const void *pNext) {
default: // Encountered an unknown sType default: // Encountered an unknown sType
// If sType is in custom list, free custom struct memory and clean up // If sType is in custom list, free custom struct memory and clean up
for (auto item : custom_stype_info) { for (auto item : GetCustomStypeInfo() ) {
if (item.first == static_cast<uint32_t>(header->sType)) { if (item.first == static_cast<uint32_t>(header->sType)) {
free(current); free(current);
break; break;