Add support for VK_EXT_debug_utils to add labels to Vulkan objects. #13792
Conversation
…n step 1 compute pipelines are getting labeled.
|
It is possible to mark queue ranges as well. I have functionality to mark the queue per graph iteration with a common name due to the lack of named information. Would it be possible to add annotation string to the graph structure like "token %i, pp" or maybe even adding the full algorithm name? |
|
This looks fine to me, but I don't currently have time to test it. @jeffbolznv Can you do a review? Also it needs to be rebased. |
ggml/src/ggml-vulkan/ggml-vulkan.cpp
Outdated
| vk::DebugUtilsObjectNameInfoEXT duoni; | ||
| duoni.objectType = vk::ObjectType::ePipeline; | ||
| duoni.pObjectName = pipeline->name.c_str(); | ||
| duoni.objectHandle = reinterpret_cast<uint64_t>(pipeline->pipeline.operator VkPipeline_T *()); |
There was a problem hiding this comment.
might be more readable as:
| duoni.objectHandle = reinterpret_cast<uint64_t>(pipeline->pipeline.operator VkPipeline_T *()); | |
| duoni.objectHandle = reinterpret_cast<uint64_t>((VkPipeline_T *)pipeline->pipeline); |
ggml/CMakeLists.txt
Outdated
| @@ -177,6 +177,7 @@ option(GGML_VULKAN_DEBUG "ggml: enable Vulkan debug output" | |||
| option(GGML_VULKAN_MEMORY_DEBUG "ggml: enable Vulkan memory debug output" OFF) | |||
| option(GGML_VULKAN_SHADER_DEBUG_INFO "ggml: enable Vulkan shader debug info" OFF) | |||
| option(GGML_VULKAN_PERF "ggml: enable Vulkan perf output" OFF) | |||
| option(GGML_VULKAN_DEBUG_UTILS "ggml: VK_EXT_debug_utils debug information" OFF) | |||
There was a problem hiding this comment.
Is the ifdef really needed? At least for labeling pipelines I don't think there's any overhead. Maybe if we eventually label command buffer regions we might need to be able to enable/disable, but even then doing it by env var would be nicer.
There was a problem hiding this comment.
In an ideal world I'd like to see cmdbuffer and queue labeling which has more overhead. The additional statement, even per cmd, might be neglectable since the branch predictor will do a good job.
If there are no objectsions by anyone else I can remove the ifdef and make the feature controllable through an environment variable instead.
There was a problem hiding this comment.
From my side, as long as it doesn't have an overhead, it can be enabled without ifdefs. If it does, it should require a compile flag.
There was a problem hiding this comment.
I've added ENV{GGML_VK_DEBUG_MARKERS} as protection with the default being off. This is sufficient cheap to not introduce any measurable overhead.
I also added queue markers with a constant name for full graph execution to make traces more readable.
Step 1: Add names to pipelines to make them easily identifiable in profiling tools.