Skip to content

apidump: Ditch C++ templates to handle output format #2623

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
charles-lunarg wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

apidump: Ditch C++ templates to handle output format #2623

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
889 changes: 427 additions & 462 deletions layersvt/api_dump.h
View file
Open in desktop

Large diffs are not rendered by default.

39 changes: 6 additions & 33 deletions layersvt/api_dump_handwritten_dispatch.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,31 +31,12 @@ extern "C" {

EXPORT_FUNCTION VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char* pName) {
PFN_vkVoidFunction instance_func = nullptr;
switch (ApiDumpInstance::current().settings().format()) {
case ApiDumpFormat::Text:
instance_func = api_dump_known_instance_functions<ApiDumpFormat::Text>(instance, pName);
break;
case ApiDumpFormat::Html:
instance_func = api_dump_known_instance_functions<ApiDumpFormat::Html>(instance, pName);
break;
case ApiDumpFormat::Json:
instance_func = api_dump_known_instance_functions<ApiDumpFormat::Json>(instance, pName);
break;
}
instance_func = api_dump_known_instance_functions(instance, pName);
if (instance_func) return instance_func;
PFN_vkVoidFunction device_func = nullptr;

switch (ApiDumpInstance::current().settings().format()) {
case ApiDumpFormat::Text:
device_func = api_dump_known_device_functions<ApiDumpFormat::Text>(NULL, pName);
break;
case ApiDumpFormat::Html:
device_func = api_dump_known_device_functions<ApiDumpFormat::Html>(NULL, pName);
break;
case ApiDumpFormat::Json:
device_func = api_dump_known_device_functions<ApiDumpFormat::Json>(NULL, pName);
break;
}
device_func = api_dump_known_device_functions(NULL, pName);

// Make sure that device functions queried through GIPA works
if (device_func) return device_func;

Expand All @@ -66,17 +47,9 @@ EXPORT_FUNCTION VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(V

EXPORT_FUNCTION VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetDeviceProcAddr(VkDevice device, const char* pName) {
PFN_vkVoidFunction device_func = nullptr;
switch (ApiDumpInstance::current().settings().format()) {
case ApiDumpFormat::Text:
device_func = api_dump_known_device_functions<ApiDumpFormat::Text>(device, pName);
break;
case ApiDumpFormat::Html:
device_func = api_dump_known_device_functions<ApiDumpFormat::Html>(device, pName);
break;
case ApiDumpFormat::Json:
device_func = api_dump_known_device_functions<ApiDumpFormat::Json>(device, pName);
break;
}

device_func = api_dump_known_device_functions(device, pName);

if (device_func) return device_func;

// Haven't created a device yet, exit now since there is no device_dispatch_table
Expand Down
77 changes: 27 additions & 50 deletions layersvt/api_dump_handwritten_functions.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,13 @@ VKAPI_ATTR VkResult VKAPI_CALL vkCreateInstance(const VkInstanceCreateInfo* pCre
_CrtSetReportMode(_CRT_ASSERT, _CRTDBG_MODE_FILE);
_CrtSetReportFile(_CRT_ASSERT, _CRTDBG_FILE_STDERR);
#endif

std::lock_guard<std::mutex> lg(ApiDumpInstance::current().outputMutex());
ApiDumpInstance::current().initLayerSettings(pCreateInfo, pAllocator);
dump_function_head(ApiDumpInstance::current(), "vkCreateInstance", "pCreateInfo, pAllocator, pInstance", "VkResult");
if (ApiDumpInstance::current().settings().shouldPreDump() &&
ApiDumpInstance::current().settings().format() == ApiDumpFormat::Text && ApiDumpInstance::current().shouldDumpOutput()) {
dump_before_pre_dump_formatting<ApiDumpFormat::Text>(ApiDumpInstance::current().settings());
dump_params_vkCreateInstance<ApiDumpFormat::Text>(ApiDumpInstance::current(), pCreateInfo, pAllocator, pInstance);
auto& api_dump = ApiDumpInstance::current();
std::lock_guard<std::mutex> lg(api_dump.outputMutex());
api_dump.initLayerSettings(pCreateInfo, pAllocator);
dump_function_head(api_dump, "vkCreateInstance", "pCreateInfo, pAllocator, pInstance", "VkResult");
if (api_dump.settings().shouldPreDump() && api_dump.settings().format() == ApiDumpFormat::Text && api_dump.shouldDumpOutput()) {
dump_before_pre_dump_formatting(api_dump);
dump_params_vkCreateInstance(api_dump, pCreateInfo, pAllocator, pInstance);
}

// Get the function pointer
Expand All @@ -70,56 +69,35 @@ VKAPI_ATTR VkResult VKAPI_CALL vkCreateInstance(const VkInstanceCreateInfo* pCre
}

// Output the API dump
if (ApiDumpInstance::current().shouldDumpOutput()) {
switch (ApiDumpInstance::current().settings().format()) {
case ApiDumpFormat::Text:
dump_return_value<ApiDumpFormat::Text>(ApiDumpInstance::current().settings(), "VkResult", result,
dump_return_value_VkResult<ApiDumpFormat::Text>);
dump_pre_function_formatting<ApiDumpFormat::Text>(ApiDumpInstance::current().settings());
dump_params_vkCreateInstance<ApiDumpFormat::Text>(ApiDumpInstance::current(), pCreateInfo, pAllocator, pInstance);
dump_post_function_formatting<ApiDumpFormat::Text>(ApiDumpInstance::current().settings());
break;
case ApiDumpFormat::Html:
dump_return_value<ApiDumpFormat::Html>(ApiDumpInstance::current().settings(), "VkResult", result,
dump_return_value_VkResult<ApiDumpFormat::Html>);
dump_pre_function_formatting<ApiDumpFormat::Html>(ApiDumpInstance::current().settings());
dump_params_vkCreateInstance<ApiDumpFormat::Html>(ApiDumpInstance::current(), pCreateInfo, pAllocator, pInstance);
dump_post_function_formatting<ApiDumpFormat::Html>(ApiDumpInstance::current().settings());
break;
case ApiDumpFormat::Json:
dump_return_value<ApiDumpFormat::Json>(ApiDumpInstance::current().settings(), "VkResult", result,
dump_return_value_VkResult<ApiDumpFormat::Json>);
dump_pre_function_formatting<ApiDumpFormat::Json>(ApiDumpInstance::current().settings());
dump_params_vkCreateInstance<ApiDumpFormat::Json>(ApiDumpInstance::current(), pCreateInfo, pAllocator, pInstance);
dump_post_function_formatting<ApiDumpFormat::Json>(ApiDumpInstance::current().settings());
break;
}
flush(ApiDumpInstance::current().settings());
if (api_dump.shouldDumpOutput()) {
dump_return_value(api_dump, "VkResult", result, dump_return_value_VkResult);
dump_pre_function_formatting(api_dump);
dump_params_vkCreateInstance(api_dump, pCreateInfo, pAllocator, pInstance);
dump_post_function_formatting(api_dump);
api_dump.settings().flush();
}

return result;
}
}

template <ApiDumpFormat Format>
VKAPI_ATTR VkResult VKAPI_CALL vkCreateDevice(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo* pCreateInfo,
const VkAllocationCallbacks* pAllocator, VkDevice* pDevice) {
std::lock_guard<std::mutex> lg(ApiDumpInstance::current().outputMutex());
dump_function_head(ApiDumpInstance::current(), "vkCreateDevice", "physicalDevice, pCreateInfo, pAllocator, pDevice",
"VkResult");
if (ApiDumpInstance::current().settings().shouldPreDump() &&
ApiDumpInstance::current().settings().format() == ApiDumpFormat::Text && ApiDumpInstance::current().shouldDumpOutput()) {
dump_before_pre_dump_formatting<ApiDumpFormat::Text>(ApiDumpInstance::current().settings());
dump_params_vkCreateDevice<ApiDumpFormat::Text>(ApiDumpInstance::current(), physicalDevice, pCreateInfo, pAllocator,
pDevice);
auto& api_dump = ApiDumpInstance::current();

std::lock_guard<std::mutex> lg(api_dump.outputMutex());
dump_function_head(api_dump, "vkCreateDevice", "physicalDevice, pCreateInfo, pAllocator, pDevice", "VkResult");
if (api_dump.settings().shouldPreDump() && api_dump.settings().format() == ApiDumpFormat::Text && api_dump.shouldDumpOutput()) {
dump_before_pre_dump_formatting(api_dump);
dump_params_vkCreateDevice(api_dump, physicalDevice, pCreateInfo, pAllocator, pDevice);
}

// Get the function pointer
VkLayerDeviceCreateInfo* chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO);
assert(chain_info->u.pLayerInfo != 0);
PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr = chain_info->u.pLayerInfo->pfnNextGetInstanceProcAddr;
PFN_vkGetDeviceProcAddr fpGetDeviceProcAddr = chain_info->u.pLayerInfo->pfnNextGetDeviceProcAddr;
VkInstance vk_instance = ApiDumpInstance::current().get_vk_instance(physicalDevice);
VkInstance vk_instance = api_dump.get_vk_instance(physicalDevice);
PFN_vkCreateDevice fpCreateDevice = (PFN_vkCreateDevice)fpGetInstanceProcAddr(vk_instance, "vkCreateDevice");
if (fpCreateDevice == NULL) {
return VK_ERROR_INITIALIZATION_FAILED;
Expand All @@ -133,13 +111,12 @@ VKAPI_ATTR VkResult VKAPI_CALL vkCreateDevice(VkPhysicalDevice physicalDevice, c
}

// Output the API dump
if (ApiDumpInstance::current().shouldDumpOutput()) {
dump_return_value<Format>(ApiDumpInstance::current().settings(), "VkResult", result, dump_return_value_VkResult<Format>);
dump_pre_function_formatting<Format>(ApiDumpInstance::current().settings());
dump_params_vkCreateDevice<Format>(ApiDumpInstance::current(), physicalDevice, pCreateInfo, pAllocator, pDevice);
dump_post_function_formatting<Format>(ApiDumpInstance::current().settings());

flush(ApiDumpInstance::current().settings());
if (api_dump.shouldDumpOutput()) {
dump_return_value(api_dump, "VkResult", result, dump_return_value_VkResult);
dump_pre_function_formatting(api_dump);
dump_params_vkCreateDevice(api_dump, physicalDevice, pCreateInfo, pAllocator, pDevice);
dump_post_function_formatting(api_dump);
api_dump.settings().flush();
}
return result;
}
Expand Down
Loading