Skip to content

Timeline: Handle missing DebugUtils extension #112

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

Merged
merged 2 commits into from
Apr 9, 2025
Merged

Timeline: Handle missing DebugUtils extension #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4be5c3d
Timeline: Handle missing DebugUtils extension
solidpixel Apr 8, 2025
ff0e1cb
Log missing extensions
solidpixel Apr 8, 2025
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
11 changes: 11 additions & 0 deletions layer_gpu_timeline/source/device.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,17 @@ Device::Device(Instance* _instance,

initDriverDeviceDispatchTable(device, nlayerGetProcAddress, driver);

// Emit a log if debug utils entry points did not load. In this scenario
// the layer will still be loaded and send metadata packets to the server
// socket, but the Perfetto data will not contain any tag labels. We will
// therefore be unable to cross-reference the two data streams to produce a
// usable visualization.
if (!driver.vkCmdBeginDebugUtilsLabelEXT)
{
LAYER_LOG(" - ERROR: Device does not expose VK_EXT_debug_utils");
LAYER_LOG(" Perfetto data will not contain cross-ref tags");
}

// Init the shared comms module for the first device built
if (!commsModule)
{
Expand Down
21 changes: 20 additions & 1 deletion layer_gpu_timeline/source/device_utils.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,24 @@
.color = {0.0f, 0.0f, 0.0f, 0.0f},
};

layer->driver.vkCmdBeginDebugUtilsLabelEXT(commandBuffer, &tagInfo);
// Function pointer may be null if driver does not expose the extension
if (layer->driver.vkCmdBeginDebugUtilsLabelEXT)
{
layer->driver.vkCmdBeginDebugUtilsLabelEXT(commandBuffer, &tagInfo);
}
}

/**
* @brief End a tag via a driver debug utils label.
*
* @param layer The layer context for the device.
* @param commandBuffer The command buffer we are recording.
*/
[[maybe_unused]] static void emitEndTag(Device* layer, VkCommandBuffer commandBuffer)
{
// Function pointer may be null if driver does not expose the extension
if (layer->driver.vkCmdEndDebugUtilsLabelEXT)
{
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
}
}
8 changes: 4 additions & 4 deletions layer_gpu_timeline/source/layer_device_functions_dispatch.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdDispatch<user_tag>(VkCommandBuffer command
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdDispatch(commandBuffer, groupCountX, groupCountY, groupCountZ);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -106,7 +106,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdDispatchBase<user_tag>(VkCommandBuffer com
emitStartTag(layer, commandBuffer, tagID);
layer->driver
.vkCmdDispatchBase(commandBuffer, baseGroupX, baseGroupY, baseGroupZ, groupCountX, groupCountY, groupCountZ);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -136,7 +136,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdDispatchBaseKHR<user_tag>(VkCommandBuffer
emitStartTag(layer, commandBuffer, tagID);
layer->driver
.vkCmdDispatchBaseKHR(commandBuffer, baseGroupX, baseGroupY, baseGroupZ, groupCountX, groupCountY, groupCountZ);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand All @@ -157,5 +157,5 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdDispatchIndirect<user_tag>(VkCommandBuffer
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdDispatchIndirect(commandBuffer, buffer, offset);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}
10 changes: 5 additions & 5 deletions layer_gpu_timeline/source/layer_device_functions_render_pass.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdEndRenderPass<user_tag>(VkCommandBuffer co
// Release the lock to call into the driver
lock.unlock();
layer->driver.vkCmdEndRenderPass(commandBuffer);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand All @@ -326,7 +326,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdEndRenderPass2<user_tag>(VkCommandBuffer c
// Release the lock to call into the driver
lock.unlock();
layer->driver.vkCmdEndRenderPass2(commandBuffer, pSubpassEndInfo);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand All @@ -343,7 +343,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdEndRenderPass2KHR<user_tag>(VkCommandBuffe
// Release the lock to call into the driver
lock.unlock();
layer->driver.vkCmdEndRenderPass2KHR(commandBuffer, pSubpassEndInfo);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand All @@ -366,7 +366,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdEndRendering<user_tag>(VkCommandBuffer com
layer->driver.vkCmdEndRendering(commandBuffer);
if (!suspending)
{
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}
}

Expand All @@ -390,6 +390,6 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdEndRenderingKHR<user_tag>(VkCommandBuffer
layer->driver.vkCmdEndRenderingKHR(commandBuffer);
if (!suspending)
{
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}
}
10 changes: 5 additions & 5 deletions layer_gpu_timeline/source/layer_device_functions_trace_rays.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdBuildAccelerationStructuresIndirectKHR<use
pIndirectDeviceAddresses,
pIndirectStrides,
ppMaxPrimitiveCounts);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand All @@ -131,7 +131,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdBuildAccelerationStructuresKHR<user_tag>(
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdBuildAccelerationStructuresKHR(commandBuffer, infoCount, pInfos, ppBuildRangeInfos);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand All @@ -151,7 +151,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdTraceRaysIndirect2KHR<user_tag>(VkCommandB
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdTraceRaysIndirect2KHR(commandBuffer, indirectDeviceAddress);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -181,7 +181,7 @@ VKAPI_ATTR void VKAPI_CALL
pHitShaderBindingTable,
pCallableShaderBindingTable,
indirectDeviceAddress);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -215,5 +215,5 @@ VKAPI_ATTR void VKAPI_CALL
width,
height,
depth);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}
36 changes: 18 additions & 18 deletions layer_gpu_timeline/source/layer_device_functions_transfer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdFillBuffer<user_tag>(VkCommandBuffer comma
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdFillBuffer(commandBuffer, dstBuffer, dstOffset, size, data);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -154,7 +154,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdClearColorImage<user_tag>(VkCommandBuffer
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -183,7 +183,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdClearDepthStencilImage<user_tag>(VkCommand
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -214,7 +214,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdCopyBuffer<user_tag>(VkCommandBuffer comma
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdCopyBuffer(commandBuffer, srcBuffer, dstBuffer, regionCount, pRegions);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -242,7 +242,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdCopyBuffer2<user_tag>(VkCommandBuffer comm
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdCopyBuffer2(commandBuffer, pCopyBufferInfo);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -270,7 +270,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdCopyBuffer2KHR<user_tag>(VkCommandBuffer c
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdCopyBuffer2KHR(commandBuffer, pCopyBufferInfo);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -305,7 +305,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdCopyBufferToImage<user_tag>(VkCommandBuffe
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -337,7 +337,7 @@ VKAPI_ATTR void VKAPI_CALL
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdCopyBufferToImage2(commandBuffer, pCopyBufferToImageInfo);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -369,7 +369,7 @@ VKAPI_ATTR void VKAPI_CALL
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -406,7 +406,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdCopyImage<user_tag>(VkCommandBuffer comman
emitStartTag(layer, commandBuffer, tagID);
layer->driver
.vkCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -437,7 +437,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdCopyImage2<user_tag>(VkCommandBuffer comma
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdCopyImage2(commandBuffer, pCopyImageInfo);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -468,7 +468,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdCopyImage2KHR<user_tag>(VkCommandBuffer co
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -507,7 +507,7 @@ VKAPI_ATTR void VKAPI_CALL layer_vkCmdCopyImageToBuffer<user_tag>(VkCommandBuffe
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -543,7 +543,7 @@ VKAPI_ATTR void VKAPI_CALL
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdCopyImageToBuffer2(commandBuffer, pCopyImageToBufferInfo);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -579,7 +579,7 @@ VKAPI_ATTR void VKAPI_CALL
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -610,7 +610,7 @@ VKAPI_ATTR void VKAPI_CALL
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdCopyAccelerationStructureKHR(commandBuffer, pInfo);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -641,7 +641,7 @@ VKAPI_ATTR void VKAPI_CALL
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdCopyAccelerationStructureToMemoryKHR(commandBuffer, pInfo);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}

/* See Vulkan API for documentation. */
Expand Down Expand Up @@ -672,5 +672,5 @@ VKAPI_ATTR void VKAPI_CALL
lock.unlock();
emitStartTag(layer, commandBuffer, tagID);
layer->driver.vkCmdCopyMemoryToAccelerationStructureKHR(commandBuffer, pInfo);
layer->driver.vkCmdEndDebugUtilsLabelEXT(commandBuffer);
emitEndTag(layer, commandBuffer);
}