1 Commits

Include renames

Author	SHA1	Message	Date
Fabian WoltermannandClaude Opus 5.5	8ef44a411d	ImGui frame profiler overlay, and Vulkan per-draw descriptor set churn fix (#7694) ... * chore: vendor ImPlot library Adds ImPlot as a build dependency, to be used for the upcoming ImGui frame profiler overlay's frametime graph and pie chart. * feat: add ImGui frame profiler overlay Replaces the old text-dump frame profile display (-profile_frame_time) with a runtime-toggleable ImGui/ImPlot overlay showing average/median frametime, a scrolling frametime graph, and a pie chart of the top contributors to frame time. Toggled via a new "Frame Profiler Overlay" option, which also seeds from -profile_frame_time for backward compatibility and now drives frame profiling collection at runtime instead of only at startup. * Add graphics and Vulkan debug stats to ImGui profiler overlay - Integrated per-backend diagnostic counters into the ImGui frame profiler overlay, triggered by `-gr_debug`. - Consolidated and cleaned up Vulkan rendering state and descriptor management for compatibility with ImGui's Vulkan pipeline. - Enabled uniform buffer and draw statistics reporting for enhanced performance insights during debugging. * Update ImPlot to v1.1 WIP and improve internal consistency - Adjust copyright notices for extended license coverage (2025-2026). - Modernize constants with `constexpr` replacements, improving type safety and clarity. - Enforce `nullptr` usage over `NULL` throughout, aligning with modern C++ practices. - Add various enhancements to ImPlot legends, markers, and axes behavior. - Introduce additional helper methods for time handling and timestamp calculations. - Address UI and typo improvements in comments and documentation, refining accuracy. * Refactor frame profiler to use per-category self-time accumulation - Introduced `accumulate_self_times` for single-pass exclusive time computation, improving performance and accuracy. - Updated `FrameProfiler` and overlay snapshot logic to leverage `Category`'s stable `getId` and `getCount`. - Replaced pie chart with a stacked bar for frame budget visualization, optimizing rendering cost. - Cached `get_tid` and `get_pid` with thread-local storage to minimize syscall overhead. - Added support for unit testing frame profiling functionality and included new test cases. - Improved code comments and clarified documentation. * Use dynamic uniform buffers to stop per-draw descriptor set churn in Vulkan The Material and PerDraw descriptor sets were reallocated and fully rewritten on essentially every draw call. model_draw_list::render_buffer rebinds ModelData with a fresh uniform buffer offset for each queued draw, and that offset was part of the Material set's memoization key, so the cache in VulkanDrawManager::applyMaterial missed every time - taking a frame-pool allocation, a full template write, the 16-entry material texture resolution and a vkUpdateDescriptorSets with it. GenericData/Matrices did the same to the PerDraw set. renderShadowDraw was worse still: all three sets allocated and rewritten per shadow draw, with no memoization at all. A large asteroid field (Solaris m21) measured 2566 descriptor sets and 19107 descriptor writes per frame at 1606 model draws, and grew an extra descriptor pool chunk every frame. Declare the bindings whose offset moves per draw - MaterialBinding::ModelData, MaterialBinding::ShadowMapData, PerDrawBinding::GenericData and PerDrawBinding::Matrices - as eUniformBufferDynamic. DescriptorWriter::setBuffer now splits a dynamic binding's offset out of the descriptor, writing {buffer, 0, range} and stashing the offset for vkCmdBindDescriptorSets' pDynamicOffsets, so an offset-only change leaves the set's contents identical and the memoization caches start hitting. Shader sources are unchanged. VulkanStateTracker::bindDescriptorSet now compares the dynamic offsets as well as the set handle. This is required, not an optimization: the common case is now the same set rebound with a new offset, and the old handle-only redundancy check would have skipped that bind and fed every draw the previous draw's uniforms. renderShadowDraw memoizes its three sets the way applyMaterial does. It does not invalidate applyMaterial's caches - those record what a set contains, the shadow pass allocates its own sets rather than overwriting theirs, and it binds through the state tracker, so the next material cache hit still rebinds correctly. Also switch allocateFrameSet to the non-allocating allocateDescriptorSets overload; the vector-returning one heap-allocated once per set, thousands of times a frame. MAX_SETS_PER_POOL stays at 1024 - the per-frame pool growth it used to log was a symptom of the churn, and one chunk now covers the scene outright. Measured on that mission in a Debug build, A/B on the same tree with and without this change: descriptor sets/frame @ ~1370 draws 2566 -> 250-345 descriptor writes/frame 19107 -> ~1700-2300 median frametime 92.9/83.6 ms -> 72.0/66.5 ms Render Buffer (profiler overlay) 24.68 ms (30.8%) -> 12.73 ms (18.4%) Build Shadow Map 5.44 ms -> off the top-5 entirely Release builds already inlined most of this away and are unchanged, as expected. Verified with the validation layers (sync validation enabled): no new VUIDs versus the same build without the change. Co-Authored-By: Claude Opus 5 <[email protected]> * Refactor Vulkan descriptor set binding to reduce dynamic offset churn - Consolidated dynamic descriptor offset logic into `DescriptorWriter::bindSets`, replacing repetitive `vkCmdBindDescriptorSets` patterns across Vulkan modules. - Eliminated redundant descriptor binding operations for Material and PerDraw sets by centralizing logic in `bindSets`. - Simplified descriptors by directly splitting offset changes from descriptor contents, avoiding unnecessary updates. - Updated comments and documentation to align with the new approach while maintaining reference consistency. - Applied optimizations across Vulkan modules (`VulkanPostProcessing`, `VulkanDescriptorManager`, etc.) to reduce per-draw overhead and improve readability. * Enable primitive restart for supported topologies in Vulkan pipeline - Added `topologySupportsPrimitiveRestart` to determine restart eligibility for each topology. - Updated `primitiveRestartEnable` to be conditionally set based on topology, addressing compatibility issues with Metal/MoltenVK. - Prevented crash scenarios on macOS by ensuring pipelines are valid for strip/fan topologies requiring primitive restart. * Enable VK_KHR_portability_subset for compatibility * Replace exception with sentinel for non-dynamic Vulkan descriptor bindings - Introduced `DYNAMIC_SLOT_INVALID` sentinel to replace the throw in `dynamic_offset_slot` for MSVC compatibility. - Added `static_assert` checks to validate binding constants, ensuring compile-time validation for dynamic offsets. - Updated comments to clarify design rationale and avoid potential misuse. * Add memory statistics and tracking to profiler overlay * fix ci issues * Add OpenGL memory statistics to the profiler overlay The memory panel showed no texture bytes and no geometry bytes under OpenGL. Only the depth renderbuffers went into the render target group. All three groups now give a value. Textures: GL_texture_bytes_used holds the bytes of every live texture cache slot. opengl_texture_release_bytes() removes the bytes of a slot at each site that drops its texture data. The bitmap render targets record the bytes of their color texture. Geometry: the unused GL_vertex_data_in global becomes GL_geometry_bytes_used, which counts only vertex and index buffers. This matches the geometry group of the Vulkan backend. gr_opengl_delete_buffer() sets the size of the buffer to 0, because opengl_destroy_all_buffers() calls it a second time for a buffer that the game already deleted. Render targets: three new functions add the scene textures, the post-processing textures, and the shadow map to the group. They sum the bytes at the moment of the call from the textures that exist, thus they need no bookkeeping at the create and delete sites. Co-Authored-By: Claude Opus 5 <[email protected]> * Fix profiler overlay crash on a category that is not a static The category registry kept a Category pointer for each id. The comment said that all categories are global statics, but that is not correct. The Lua API tracing_category constructs a Category and copies it into a script-owned object. The registry then kept a pointer to the dead temporary. build_overlay_snapshot called getName() on that pointer, made an SCP_string from the garbage char*, and the process stopped with SIGABRT. The registry now keeps the name by value and never keeps a Category pointer. getById() becomes getNameById(), which is all that build_overlay_snapshot needs. A copy of a Category keeps the id of the original, which stays correct because the id only selects a name. Add two tests: one shows that the name stays available after the Category object is dead, and one drives the full path that failed, from processEvent to the overlay snapshot. Co-Authored-By: Claude Opus 5 <[email protected]> * Replace category pointers with IDs to prevent use-after-free - Updated `trace_event` to store `category_id` instead of a pointer to prevent dangling references to category objects that may already be destroyed. - Modified all references to category names to use `Category::getNameById()` instead of dereferencing pointers. - Expanded memory statistics in the profiler overlay with new sound, Lua, and OS-level memory usage tracking. - Added new tests to verify proper use of category IDs in frame profiling and event tracing. - Improved memory safety and stability across tracing, profiling, and overlay systems. * Refactor profiler overlay to use snapshot-based frame timing * Address review feedback on the profiler overlay Skip complete::end for a scope that did not start. This fixes a crash when Lua turns the overlay on while a scope is open. Track the GPU begin event so that turning the overlay off mid-scope still closes it. Use XSTR 1936 and 1937 for the overlay option. Master now uses 1932 and 1933. Remove the default value of dynamicOffsets in bindDescriptorSet. Use the PerDraw binding constants in the PerDraw key. Co-Authored-By: Claude Sonnet 5.5 <[email protected]> * Use wall-clock frame time and read the history without a copy The Avg and FPS line used traced self-time, which reads too high. Measure the time between overlay frames instead. Draw the graph with PlotLineG so the history deque needs no per-frame copy. Co-Authored-By: Claude Sonnet 5.5 <[email protected]> * Address second round of review feedback on the profiler overlay - Make the category registry thread-safe and give categories with the same name one id, so the registry does not grow without limit. - Add tests that toggle the profiler inside an open trace scope. - Correct the next free XSTR id note to 1938. - Use the existing Windows include block for psapi.h in osapi.cpp. - Use list_range in ship_get_num_ships() and shorten some comments. Co-Authored-By: Claude Opus 5.5 <[email protected]> * Return size_t from Category::getCount() and tidy the registry code - Use structured bindings and std::scoped_lock in the category registry. - Return size_t from getCount() and update its callers and tests. Co-Authored-By: Claude Opus 5.5 <[email protected]> * Address third round of review feedback on the profiler overlay - Move the overlay option strings to XSTR 1940 and 1941. The touch overlay on master uses 1936 to 1939. - Give FrameProfiler the main thread ID when it is made. Before, it used the thread of the first event, which was a race. - Let mouse motion go to the game while the pointer is over the overlay, so that mouse flight does not stop there. - Find the dynamic bindings of the PerDraw key with dynamic_offset_slot(), as the other call sites do. - Make disable_inside_open_scope count the GPU timestamp queries, so that it fails if end() does not close the GPU event. - Make the copy test copy the category, not bind a reference. Co-Authored-By: Claude Opus 5.5 <[email protected]> * apply review suggestions --------- Co-authored-by: Claude Opus 5 <[email protected]>	2026-11-11 08:16:33 +01:00