Jeremy Gebben | 4d51c55 | 2022-01-06 21:27:15 -0700 | [diff] [blame] | 1 | /* Copyright (c) 2015-2022 The Khronos Group Inc. |
| 2 | * Copyright (c) 2015-2022 Valve Corporation |
| 3 | * Copyright (c) 2015-2022 LunarG, Inc. |
| 4 | * Copyright (C) 2015-2022 Google Inc. |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 5 | * Modifications Copyright (C) 2020 Advanced Micro Devices, Inc. All rights reserved. |
| 6 | * |
| 7 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 8 | * you may not use this file except in compliance with the License. |
| 9 | * You may obtain a copy of the License at |
| 10 | * |
| 11 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 12 | * |
| 13 | * Unless required by applicable law or agreed to in writing, software |
| 14 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 16 | * See the License for the specific language governing permissions and |
| 17 | * limitations under the License. |
| 18 | * |
| 19 | * Author: Courtney Goeltzenleuchter <courtneygo@google.com> |
| 20 | * Author: Tobin Ehlis <tobine@google.com> |
| 21 | * Author: Chris Forbes <chrisf@ijw.co.nz> |
| 22 | * Author: Mark Lobodzinski <mark@lunarg.com> |
| 23 | * Author: Dave Houlton <daveh@lunarg.com> |
| 24 | * Author: John Zulauf <jzulauf@lunarg.com> |
| 25 | * Author: Tobias Hector <tobias.hector@amd.com> |
| 26 | */ |
| 27 | #pragma once |
| 28 | #include "base_node.h" |
| 29 | #include "query_state.h" |
| 30 | #include "command_validation.h" |
| 31 | #include "hash_vk_types.h" |
| 32 | #include "subresource_adapter.h" |
| 33 | #include "image_layout_map.h" |
| 34 | #include "pipeline_state.h" |
| 35 | #include "device_state.h" |
| 36 | #include "descriptor_sets.h" |
| 37 | #include "qfo_transfer.h" |
| 38 | |
Jeremy Gebben | 1ec8933 | 2021-08-05 13:51:49 -0600 | [diff] [blame] | 39 | struct SUBPASS_INFO; |
| 40 | class FRAMEBUFFER_STATE; |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 41 | class RENDER_PASS_STATE; |
| 42 | class CoreChecks; |
| 43 | class ValidationStateTracker; |
| 44 | |
| 45 | class EVENT_STATE : public BASE_NODE { |
| 46 | public: |
| 47 | int write_in_use; |
| 48 | VkPipelineStageFlags2KHR stageMask = VkPipelineStageFlags2KHR(0); |
| 49 | VkEventCreateFlags flags; |
| 50 | |
| 51 | EVENT_STATE(VkEvent event_, VkEventCreateFlags flags_) |
| 52 | : BASE_NODE(event_, kVulkanObjectTypeEvent), write_in_use(0), flags(flags_) {} |
| 53 | |
| 54 | VkEvent event() const { return handle_.Cast<VkEvent>(); } |
| 55 | }; |
| 56 | |
| 57 | // Only CoreChecks uses this, but the state tracker stores it. |
| 58 | constexpr static auto kInvalidLayout = image_layout_map::kInvalidLayout; |
| 59 | using ImageSubresourceLayoutMap = image_layout_map::ImageSubresourceLayoutMap; |
| 60 | typedef layer_data::unordered_map<VkEvent, VkPipelineStageFlags2KHR> EventToStageMap; |
| 61 | |
| 62 | // Track command pools and their command buffers |
| 63 | class COMMAND_POOL_STATE : public BASE_NODE { |
| 64 | public: |
Jeremy Gebben | cd7fa28 | 2021-10-27 10:25:32 -0600 | [diff] [blame] | 65 | ValidationStateTracker *dev_data; |
Jeremy Gebben | 1ec8933 | 2021-08-05 13:51:49 -0600 | [diff] [blame] | 66 | const VkCommandPoolCreateFlags createFlags; |
| 67 | const uint32_t queueFamilyIndex; |
| 68 | const VkQueueFlags queue_flags; |
| 69 | const bool unprotected; // can't be used for protected memory |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 70 | // Cmd buffers allocated from this pool |
Jeremy Gebben | cd7fa28 | 2021-10-27 10:25:32 -0600 | [diff] [blame] | 71 | layer_data::unordered_map<VkCommandBuffer, CMD_BUFFER_STATE *> commandBuffers; |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 72 | |
Jeremy Gebben | cd7fa28 | 2021-10-27 10:25:32 -0600 | [diff] [blame] | 73 | COMMAND_POOL_STATE(ValidationStateTracker *dev, VkCommandPool cp, const VkCommandPoolCreateInfo *pCreateInfo, |
| 74 | VkQueueFlags flags); |
| 75 | virtual ~COMMAND_POOL_STATE() { Destroy(); } |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 76 | |
| 77 | VkCommandPool commandPool() const { return handle_.Cast<VkCommandPool>(); } |
| 78 | |
Jeremy Gebben | cd7fa28 | 2021-10-27 10:25:32 -0600 | [diff] [blame] | 79 | void Allocate(const VkCommandBufferAllocateInfo *create_info, const VkCommandBuffer *command_buffers); |
| 80 | void Free(uint32_t count, const VkCommandBuffer *command_buffers); |
| 81 | void Reset(); |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 82 | |
Jeremy Gebben | cd7fa28 | 2021-10-27 10:25:32 -0600 | [diff] [blame] | 83 | void Destroy() override; |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 84 | }; |
| 85 | |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 86 | // Autogenerated as part of the command_validation.h codegen |
| 87 | const char *CommandTypeString(CMD_TYPE type); |
| 88 | |
| 89 | enum CB_STATE { |
| 90 | CB_NEW, // Newly created CB w/o any cmds |
| 91 | CB_RECORDING, // BeginCB has been called on this CB |
| 92 | CB_RECORDED, // EndCB has been called on this CB |
| 93 | CB_INVALID_COMPLETE, // had a complete recording, but was since invalidated |
| 94 | CB_INVALID_INCOMPLETE, // fouled before recording was completed |
| 95 | }; |
| 96 | |
| 97 | // CB Status -- used to track status of various bindings on cmd buffer objects |
| 98 | typedef uint64_t CBStatusFlags; |
| 99 | enum CBStatusFlagBits : uint64_t { |
| 100 | // clang-format off |
| 101 | CBSTATUS_NONE = 0x00000000, // No status is set |
| 102 | CBSTATUS_LINE_WIDTH_SET = 0x00000001, // Line width has been set |
| 103 | CBSTATUS_DEPTH_BIAS_SET = 0x00000002, // Depth bias has been set |
| 104 | CBSTATUS_BLEND_CONSTANTS_SET = 0x00000004, // Blend constants state has been set |
| 105 | CBSTATUS_DEPTH_BOUNDS_SET = 0x00000008, // Depth bounds state object has been set |
| 106 | CBSTATUS_STENCIL_READ_MASK_SET = 0x00000010, // Stencil read mask has been set |
| 107 | CBSTATUS_STENCIL_WRITE_MASK_SET = 0x00000020, // Stencil write mask has been set |
| 108 | CBSTATUS_STENCIL_REFERENCE_SET = 0x00000040, // Stencil reference has been set |
| 109 | CBSTATUS_VIEWPORT_SET = 0x00000080, |
| 110 | CBSTATUS_SCISSOR_SET = 0x00000100, |
| 111 | CBSTATUS_INDEX_BUFFER_BOUND = 0x00000200, // Index buffer has been set |
| 112 | CBSTATUS_EXCLUSIVE_SCISSOR_SET = 0x00000400, |
| 113 | CBSTATUS_SHADING_RATE_PALETTE_SET = 0x00000800, |
| 114 | CBSTATUS_LINE_STIPPLE_SET = 0x00001000, |
| 115 | CBSTATUS_VIEWPORT_W_SCALING_SET = 0x00002000, |
| 116 | CBSTATUS_CULL_MODE_SET = 0x00004000, |
| 117 | CBSTATUS_FRONT_FACE_SET = 0x00008000, |
| 118 | CBSTATUS_PRIMITIVE_TOPOLOGY_SET = 0x00010000, |
| 119 | CBSTATUS_VIEWPORT_WITH_COUNT_SET = 0x00020000, |
| 120 | CBSTATUS_SCISSOR_WITH_COUNT_SET = 0x00040000, |
| 121 | CBSTATUS_VERTEX_INPUT_BINDING_STRIDE_SET = 0x00080000, |
| 122 | CBSTATUS_DEPTH_TEST_ENABLE_SET = 0x00100000, |
| 123 | CBSTATUS_DEPTH_WRITE_ENABLE_SET = 0x00200000, |
| 124 | CBSTATUS_DEPTH_COMPARE_OP_SET = 0x00400000, |
| 125 | CBSTATUS_DEPTH_BOUNDS_TEST_ENABLE_SET = 0x00800000, |
| 126 | CBSTATUS_STENCIL_TEST_ENABLE_SET = 0x01000000, |
| 127 | CBSTATUS_STENCIL_OP_SET = 0x02000000, |
| 128 | CBSTATUS_DISCARD_RECTANGLE_SET = 0x04000000, |
| 129 | CBSTATUS_SAMPLE_LOCATIONS_SET = 0x08000000, |
| 130 | CBSTATUS_COARSE_SAMPLE_ORDER_SET = 0x10000000, |
| 131 | CBSTATUS_PATCH_CONTROL_POINTS_SET = 0x20000000, |
| 132 | CBSTATUS_RASTERIZER_DISCARD_ENABLE_SET = 0x40000000, |
| 133 | CBSTATUS_DEPTH_BIAS_ENABLE_SET = 0x80000000, |
| 134 | CBSTATUS_LOGIC_OP_SET = 0x100000000, |
| 135 | CBSTATUS_PRIMITIVE_RESTART_ENABLE_SET = 0x200000000, |
| 136 | CBSTATUS_VERTEX_INPUT_SET = 0x400000000, |
| 137 | CBSTATUS_ALL_STATE_SET = 0x7FFFFFDFF, // All state set (intentionally exclude index buffer) |
| 138 | // clang-format on |
| 139 | }; |
| 140 | |
| 141 | VkDynamicState ConvertToDynamicState(CBStatusFlagBits flag); |
| 142 | CBStatusFlagBits ConvertToCBStatusFlagBits(VkDynamicState state); |
| 143 | std::string DynamicStateString(CBStatusFlags input_value); |
| 144 | |
| 145 | struct BufferBinding { |
| 146 | std::shared_ptr<BUFFER_STATE> buffer_state; |
| 147 | VkDeviceSize size; |
| 148 | VkDeviceSize offset; |
| 149 | VkDeviceSize stride; |
| 150 | |
| 151 | BufferBinding() : buffer_state(), size(0), offset(0), stride(0) {} |
| 152 | virtual ~BufferBinding() {} |
| 153 | |
| 154 | virtual void reset() { *this = BufferBinding(); } |
| 155 | }; |
| 156 | |
| 157 | struct IndexBufferBinding : BufferBinding { |
| 158 | VkIndexType index_type; |
| 159 | |
| 160 | IndexBufferBinding() : BufferBinding(), index_type(static_cast<VkIndexType>(0)) {} |
| 161 | virtual ~IndexBufferBinding() {} |
| 162 | |
| 163 | virtual void reset() override { *this = IndexBufferBinding(); } |
| 164 | }; |
| 165 | |
| 166 | struct CBVertexBufferBindingInfo { |
| 167 | std::vector<BufferBinding> vertex_buffer_bindings; |
| 168 | }; |
| 169 | |
Jeremy Gebben | 4a8881f | 2022-01-10 17:04:30 -0700 | [diff] [blame] | 170 | typedef layer_data::unordered_map<const IMAGE_STATE *, std::shared_ptr<ImageSubresourceLayoutMap>> CommandBufferImageLayoutMap; |
| 171 | |
| 172 | typedef layer_data::unordered_map<const GlobalImageLayoutRangeMap *, std::shared_ptr<ImageSubresourceLayoutMap>> |
| 173 | CommandBufferAliasedLayoutMap; |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 174 | |
| 175 | class CMD_BUFFER_STATE : public REFCOUNTED_NODE { |
| 176 | public: |
| 177 | VkCommandBufferAllocateInfo createInfo = {}; |
| 178 | VkCommandBufferBeginInfo beginInfo; |
| 179 | VkCommandBufferInheritanceInfo inheritanceInfo; |
Jeremy Gebben | cd7fa28 | 2021-10-27 10:25:32 -0600 | [diff] [blame] | 180 | // since command buffers can only be destroyed by their command pool, this does not need to be a shared_ptr |
| 181 | const COMMAND_POOL_STATE *command_pool; |
Jeremy Gebben | 1ec8933 | 2021-08-05 13:51:49 -0600 | [diff] [blame] | 182 | ValidationStateTracker *dev_data; |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 183 | bool hasDrawCmd; |
| 184 | bool hasTraceRaysCmd; |
| 185 | bool hasBuildAccelerationStructureCmd; |
| 186 | bool hasDispatchCmd; |
| 187 | bool unprotected; // can't be used for protected memory |
| 188 | |
| 189 | CB_STATE state; // Track cmd buffer update state |
| 190 | uint64_t commandCount; // Number of commands recorded. Currently only used with VK_KHR_performance_query |
| 191 | uint64_t submitCount; // Number of times CB has been submitted |
| 192 | typedef uint64_t ImageLayoutUpdateCount; |
| 193 | ImageLayoutUpdateCount image_layout_change_count; // The sequence number for changes to image layout (for cached validation) |
| 194 | CBStatusFlags status; // Track status of various bindings on cmd buffer |
| 195 | CBStatusFlags static_status; // All state bits provided by current graphics pipeline |
| 196 | // rather than dynamic state |
| 197 | CBStatusFlags dynamic_status; // dynamic state set up in pipeline |
Tony-LunarG | 40b3388 | 2021-12-02 12:40:11 -0700 | [diff] [blame] | 198 | std::string begin_rendering_func_name; |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 199 | // Currently storing "lastBound" objects on per-CB basis |
| 200 | // long-term may want to create caches of "lastBound" states and could have |
| 201 | // each individual CMD_NODE referencing its own "lastBound" state |
| 202 | // Store last bound state for Gfx & Compute pipeline bind points |
| 203 | std::array<LAST_BOUND_STATE, BindPoint_Count> lastBound; // index is LvlBindPoint. |
| 204 | |
| 205 | struct CmdDrawDispatchInfo { |
| 206 | CMD_TYPE cmd_type; |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 207 | std::vector<std::pair<const uint32_t, DescriptorRequirement>> binding_infos; |
| 208 | VkFramebuffer framebuffer; |
| 209 | std::shared_ptr<std::vector<SUBPASS_INFO>> subpasses; |
| 210 | std::shared_ptr<std::vector<IMAGE_VIEW_STATE *>> attachments; |
| 211 | }; |
| 212 | layer_data::unordered_map<VkDescriptorSet, std::vector<CmdDrawDispatchInfo>> validate_descriptorsets_in_queuesubmit; |
| 213 | |
| 214 | // If VK_NV_inherited_viewport_scissor is enabled and VkCommandBufferInheritanceViewportScissorInfoNV::viewportScissor2D is |
| 215 | // true, then is the nonempty list of viewports passed in pViewportDepths. Otherwise, this is empty. |
| 216 | std::vector<VkViewport> inheritedViewportDepths; |
| 217 | |
| 218 | // For each draw command D recorded to this command buffer, let |
| 219 | // * g_D be the graphics pipeline used |
| 220 | // * v_G be the viewportCount of g_D (0 if g_D disables rasterization or enables VK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT) |
| 221 | // * s_G be the scissorCount of g_D (0 if g_D disables rasterization or enables VK_DYNAMIC_STATE_SCISSOR_WITH_COUNT_EXT) |
| 222 | // Then this value is max(0, max(v_G for all D in cb), max(s_G for all D in cb)) |
| 223 | uint32_t usedViewportScissorCount; |
| 224 | uint32_t pipelineStaticViewportCount; // v_G for currently-bound graphics pipeline. |
| 225 | uint32_t pipelineStaticScissorCount; // s_G for currently-bound graphics pipeline. |
| 226 | |
| 227 | uint32_t viewportMask; |
| 228 | uint32_t viewportWithCountMask; |
| 229 | uint32_t viewportWithCountCount; |
| 230 | uint32_t scissorMask; |
| 231 | uint32_t scissorWithCountMask; |
| 232 | uint32_t scissorWithCountCount; |
| 233 | |
| 234 | // Dynamic viewports set in this command buffer; if bit j of viewportMask is set then dynamicViewports[j] is valid, but the |
| 235 | // converse need not be true. |
| 236 | std::vector<VkViewport> dynamicViewports; |
| 237 | |
| 238 | // Bits set when binding graphics pipeline defining corresponding static state, or executing any secondary command buffer. |
| 239 | // Bits unset by calling a corresponding vkCmdSet[State] cmd. |
| 240 | uint32_t trashedViewportMask; |
| 241 | uint32_t trashedScissorMask; |
| 242 | bool trashedViewportCount; |
| 243 | bool trashedScissorCount; |
| 244 | |
| 245 | // True iff any draw command recorded to this command buffer consumes dynamic viewport/scissor with count state. |
| 246 | bool usedDynamicViewportCount; |
| 247 | bool usedDynamicScissorCount; |
| 248 | |
| 249 | uint32_t initial_device_mask; |
| 250 | VkPrimitiveTopology primitiveTopology; |
| 251 | |
| 252 | safe_VkRenderPassBeginInfo activeRenderPassBeginInfo; |
| 253 | std::shared_ptr<RENDER_PASS_STATE> activeRenderPass; |
| 254 | std::shared_ptr<std::vector<SUBPASS_INFO>> active_subpasses; |
| 255 | std::shared_ptr<std::vector<IMAGE_VIEW_STATE *>> active_attachments; |
| 256 | std::set<std::shared_ptr<IMAGE_VIEW_STATE>> attachments_view_states; |
| 257 | |
| 258 | VkSubpassContents activeSubpassContents; |
| 259 | uint32_t active_render_pass_device_mask; |
| 260 | uint32_t activeSubpass; |
| 261 | std::shared_ptr<FRAMEBUFFER_STATE> activeFramebuffer; |
| 262 | layer_data::unordered_set<std::shared_ptr<FRAMEBUFFER_STATE>> framebuffers; |
| 263 | // Unified data structs to track objects bound to this command buffer as well as object |
| 264 | // dependencies that have been broken : either destroyed objects, or updated descriptor sets |
Jeremy Gebben | 610d3a6 | 2022-01-01 12:53:17 -0700 | [diff] [blame] | 265 | layer_data::unordered_set<std::shared_ptr<BASE_NODE>> object_bindings; |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 266 | layer_data::unordered_map<VulkanTypedHandle, LogObjectList> broken_bindings; |
| 267 | |
| 268 | QFOTransferBarrierSets<QFOBufferTransferBarrier> qfo_transfer_buffer_barriers; |
| 269 | QFOTransferBarrierSets<QFOImageTransferBarrier> qfo_transfer_image_barriers; |
| 270 | |
| 271 | layer_data::unordered_set<VkEvent> waitedEvents; |
| 272 | std::vector<VkEvent> writeEventsBeforeWait; |
| 273 | std::vector<VkEvent> events; |
| 274 | layer_data::unordered_set<QueryObject> activeQueries; |
| 275 | layer_data::unordered_set<QueryObject> startedQueries; |
| 276 | layer_data::unordered_set<QueryObject> resetQueries; |
ziga-lunarg | 96c7d82 | 2022-02-28 19:39:17 +0100 | [diff] [blame^] | 277 | layer_data::unordered_set<QueryObject> updatedQueries; |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 278 | CommandBufferImageLayoutMap image_layout_map; |
Jeremy Gebben | 4a8881f | 2022-01-10 17:04:30 -0700 | [diff] [blame] | 279 | CommandBufferAliasedLayoutMap aliased_image_layout_map; // storage for potentially aliased images |
| 280 | |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 281 | CBVertexBufferBindingInfo current_vertex_buffer_binding_info; |
| 282 | bool vertex_buffer_used; // Track for perf warning to make sure any bound vtx buffer used |
| 283 | VkCommandBuffer primaryCommandBuffer; |
| 284 | // If primary, the secondary command buffers we will call. |
| 285 | // If secondary, the primary command buffers we will be called by. |
| 286 | layer_data::unordered_set<CMD_BUFFER_STATE *> linkedCommandBuffers; |
| 287 | // Validation functions run at primary CB queue submit time |
Jeremy Gebben | e5361dd | 2021-11-18 14:23:56 -0700 | [diff] [blame] | 288 | using QueueCallback = std::function<bool(const ValidationStateTracker &device_data, const class QUEUE_STATE &queue_state, |
| 289 | const CMD_BUFFER_STATE &cb_state)>; |
| 290 | std::vector<QueueCallback> queue_submit_functions; |
Hans-Kristian Arntzen | 59c2c3f | 2021-06-14 11:40:12 +0200 | [diff] [blame] | 291 | // Used by some layers to defer actions until vkCmdEndRenderPass time. |
| 292 | // Layers using this are responsible for inserting the callbacks into queue_submit_functions. |
Jeremy Gebben | e5361dd | 2021-11-18 14:23:56 -0700 | [diff] [blame] | 293 | std::vector<QueueCallback> queue_submit_functions_after_render_pass; |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 294 | // Validation functions run when secondary CB is executed in primary |
Jeremy Gebben | 057f9d5 | 2021-11-05 14:12:31 -0600 | [diff] [blame] | 295 | std::vector<std::function<bool(const CMD_BUFFER_STATE &secondary, const CMD_BUFFER_STATE *primary, const FRAMEBUFFER_STATE *)>> |
| 296 | cmd_execute_commands_functions; |
Jeremy Gebben | 332d4dd | 2022-01-01 12:40:02 -0700 | [diff] [blame] | 297 | std::vector<std::function<bool(CMD_BUFFER_STATE &cb, bool do_validate, EventToStageMap *localEventToStageMap)>> eventUpdates; |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 298 | std::vector<std::function<bool(const ValidationStateTracker *device_data, bool do_validate, VkQueryPool &firstPerfQueryPool, |
| 299 | uint32_t perfQueryPass, QueryMap *localQueryToStateMap)>> |
| 300 | queryUpdates; |
Jeremy Gebben | 87db52f | 2021-10-14 13:55:09 -0600 | [diff] [blame] | 301 | layer_data::unordered_set<const cvdescriptorset::DescriptorSet *> validated_descriptor_sets; |
| 302 | layer_data::unordered_map<const cvdescriptorset::DescriptorSet *, cvdescriptorset::DescriptorSet::CachedValidation> |
| 303 | descriptorset_cache; |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 304 | // Contents valid only after an index buffer is bound (CBSTATUS_INDEX_BUFFER_BOUND set) |
| 305 | IndexBufferBinding index_buffer_binding; |
| 306 | bool performance_lock_acquired = false; |
| 307 | bool performance_lock_released = false; |
| 308 | |
| 309 | // Cache of current insert label... |
| 310 | LoggingLabel debug_label; |
| 311 | |
| 312 | std::vector<uint8_t> push_constant_data; |
| 313 | PushConstantRangesId push_constant_data_ranges; |
| 314 | |
| 315 | std::map<VkShaderStageFlagBits, std::vector<uint8_t>> |
| 316 | push_constant_data_update; // vector's value is enum PushConstantByteState. |
| 317 | VkPipelineLayout push_constant_pipeline_layout_set; |
| 318 | |
| 319 | // Used for Best Practices tracking |
| 320 | uint32_t small_indexed_draw_call_count; |
| 321 | |
| 322 | bool transform_feedback_active{false}; |
ziga-lunarg | 40f5fbc | 2021-08-14 23:06:41 +0200 | [diff] [blame] | 323 | bool conditional_rendering_active{false}; |
ziga-lunarg | 39eeaf2 | 2021-09-03 19:12:44 +0200 | [diff] [blame] | 324 | bool conditional_rendering_inside_render_pass{false}; |
| 325 | uint32_t conditional_rendering_subpass{0}; |
Jeremy Gebben | 332d4dd | 2022-01-01 12:40:02 -0700 | [diff] [blame] | 326 | mutable ReadWriteLock lock; |
| 327 | ReadLockGuard ReadLock() const { return ReadLockGuard(lock); } |
| 328 | WriteLockGuard WriteLock() { return WriteLockGuard(lock); } |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 329 | |
Jeremy Gebben | 3d22d58 | 2021-08-11 15:37:58 -0600 | [diff] [blame] | 330 | CMD_BUFFER_STATE(ValidationStateTracker *, VkCommandBuffer cb, const VkCommandBufferAllocateInfo *pCreateInfo, |
Jeremy Gebben | cd7fa28 | 2021-10-27 10:25:32 -0600 | [diff] [blame] | 331 | const COMMAND_POOL_STATE *cmd_pool); |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 332 | |
Jeremy Gebben | 3d22d58 | 2021-08-11 15:37:58 -0600 | [diff] [blame] | 333 | virtual ~CMD_BUFFER_STATE() { Destroy(); } |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 334 | |
| 335 | void Destroy() override; |
| 336 | |
| 337 | VkCommandBuffer commandBuffer() const { return handle_.Cast<VkCommandBuffer>(); } |
| 338 | |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 339 | IMAGE_VIEW_STATE *GetActiveAttachmentImageViewState(uint32_t index); |
| 340 | const IMAGE_VIEW_STATE *GetActiveAttachmentImageViewState(uint32_t index) const; |
| 341 | |
Jeremy Gebben | 610d3a6 | 2022-01-01 12:53:17 -0700 | [diff] [blame] | 342 | void AddChild(std::shared_ptr<BASE_NODE> &base_node); |
Jeremy Gebben | 9f53710 | 2021-10-05 16:37:12 -0600 | [diff] [blame] | 343 | template <typename StateObject> |
| 344 | void AddChild(std::shared_ptr<StateObject> &child_node) { |
Jeremy Gebben | 610d3a6 | 2022-01-01 12:53:17 -0700 | [diff] [blame] | 345 | auto base = std::static_pointer_cast<BASE_NODE>(child_node); |
| 346 | AddChild(base); |
Jeremy Gebben | 9f53710 | 2021-10-05 16:37:12 -0600 | [diff] [blame] | 347 | } |
| 348 | |
Jeremy Gebben | 610d3a6 | 2022-01-01 12:53:17 -0700 | [diff] [blame] | 349 | void RemoveChild(std::shared_ptr<BASE_NODE> &base_node); |
| 350 | template <typename StateObject> |
| 351 | void RemoveChild(std::shared_ptr<StateObject> &child_node) { |
| 352 | auto base = std::static_pointer_cast<BASE_NODE>(child_node); |
| 353 | RemoveChild(base); |
| 354 | } |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 355 | |
Jeremy Gebben | 3d22d58 | 2021-08-11 15:37:58 -0600 | [diff] [blame] | 356 | virtual void Reset(); |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 357 | |
Jeremy Gebben | 1ec8933 | 2021-08-05 13:51:49 -0600 | [diff] [blame] | 358 | void IncrementResources(); |
| 359 | |
| 360 | void ResetPushConstantDataIfIncompatible(const PIPELINE_LAYOUT_STATE *pipeline_layout_state); |
| 361 | |
Jeremy Gebben | 6335df6 | 2021-11-01 10:50:13 -0600 | [diff] [blame] | 362 | const ImageSubresourceLayoutMap *GetImageSubresourceLayoutMap(const IMAGE_STATE &image_state) const; |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 363 | ImageSubresourceLayoutMap *GetImageSubresourceLayoutMap(const IMAGE_STATE &image_state); |
ziga-lunarg | 189ae5d | 2021-10-19 13:09:58 +0200 | [diff] [blame] | 364 | const CommandBufferImageLayoutMap& GetImageSubresourceLayoutMap() const; |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 365 | |
| 366 | const QFOTransferBarrierSets<QFOImageTransferBarrier> &GetQFOBarrierSets(const QFOImageTransferBarrier &type_tag) const { |
| 367 | return qfo_transfer_image_barriers; |
| 368 | } |
| 369 | |
| 370 | const QFOTransferBarrierSets<QFOBufferTransferBarrier> &GetQFOBarrierSets(const QFOBufferTransferBarrier &type_tag) const { |
| 371 | return qfo_transfer_buffer_barriers; |
| 372 | } |
| 373 | |
| 374 | QFOTransferBarrierSets<QFOImageTransferBarrier> &GetQFOBarrierSets(const QFOImageTransferBarrier &type_tag) { |
| 375 | return qfo_transfer_image_barriers; |
| 376 | } |
| 377 | |
| 378 | QFOTransferBarrierSets<QFOBufferTransferBarrier> &GetQFOBarrierSets(const QFOBufferTransferBarrier &type_tag) { |
| 379 | return qfo_transfer_buffer_barriers; |
| 380 | } |
| 381 | |
| 382 | PIPELINE_STATE *GetCurrentPipeline(VkPipelineBindPoint pipelineBindPoint) const { |
| 383 | const auto lv_bind_point = ConvertToLvlBindPoint(pipelineBindPoint); |
| 384 | return lastBound[lv_bind_point].pipeline_state; |
| 385 | } |
| 386 | |
| 387 | void GetCurrentPipelineAndDesriptorSets(VkPipelineBindPoint pipelineBindPoint, const PIPELINE_STATE **rtn_pipe, |
| 388 | const std::vector<LAST_BOUND_STATE::PER_SET> **rtn_sets) const { |
| 389 | const auto lv_bind_point = ConvertToLvlBindPoint(pipelineBindPoint); |
| 390 | const auto &last_bound_it = lastBound[lv_bind_point]; |
| 391 | if (!last_bound_it.IsUsing()) { |
| 392 | return; |
| 393 | } |
| 394 | *rtn_pipe = last_bound_it.pipeline_state; |
| 395 | *rtn_sets = &(last_bound_it.per_set); |
| 396 | } |
| 397 | |
| 398 | VkQueueFlags GetQueueFlags() const { |
| 399 | return command_pool->queue_flags; |
| 400 | } |
| 401 | |
Jeremy Gebben | efead33 | 2021-06-18 08:22:44 -0600 | [diff] [blame] | 402 | template <typename Barrier> |
Jeremy Gebben | 7ba5615 | 2021-06-18 10:40:10 -0600 | [diff] [blame] | 403 | inline bool IsReleaseOp(const Barrier &barrier) const { |
| 404 | return (IsTransferOp(barrier)) && (command_pool->queueFamilyIndex == barrier.srcQueueFamilyIndex); |
| 405 | } |
| 406 | template <typename Barrier> |
| 407 | inline bool IsAcquireOp(const Barrier &barrier) const { |
| 408 | return (IsTransferOp(barrier)) && (command_pool->queueFamilyIndex == barrier.dstQueueFamilyIndex); |
Jeremy Gebben | efead33 | 2021-06-18 08:22:44 -0600 | [diff] [blame] | 409 | } |
| 410 | |
Jeremy Gebben | 1ec8933 | 2021-08-05 13:51:49 -0600 | [diff] [blame] | 411 | void Begin(const VkCommandBufferBeginInfo *pBeginInfo); |
| 412 | void End(VkResult result); |
| 413 | |
| 414 | void BeginQuery(const QueryObject &query_obj); |
| 415 | void EndQuery(const QueryObject &query_obj); |
| 416 | void EndQueries(VkQueryPool queryPool, uint32_t firstQuery, uint32_t queryCount); |
| 417 | void ResetQueryPool(VkQueryPool queryPool, uint32_t firstQuery, uint32_t queryCount); |
| 418 | |
Jeremy Gebben | 10a0ed1 | 2021-08-17 09:54:29 -0600 | [diff] [blame] | 419 | void BeginRenderPass(CMD_TYPE cmd_type, const VkRenderPassBeginInfo *pRenderPassBegin, VkSubpassContents contents); |
| 420 | void NextSubpass(CMD_TYPE cmd_type, VkSubpassContents contents); |
| 421 | void EndRenderPass(CMD_TYPE cmd_type); |
Jeremy Gebben | 1ec8933 | 2021-08-05 13:51:49 -0600 | [diff] [blame] | 422 | |
Tony-LunarG | 40b3388 | 2021-12-02 12:40:11 -0700 | [diff] [blame] | 423 | void BeginRendering(CMD_TYPE cmd_type, const VkRenderingInfo *pRenderingInfo); |
amhagan | a448ea5 | 2021-11-02 14:09:14 -0400 | [diff] [blame] | 424 | |
Jeremy Gebben | 1ec8933 | 2021-08-05 13:51:49 -0600 | [diff] [blame] | 425 | void ExecuteCommands(uint32_t commandBuffersCount, const VkCommandBuffer *pCommandBuffers); |
| 426 | |
| 427 | void UpdateLastBoundDescriptorSets(VkPipelineBindPoint pipeline_bind_point, const PIPELINE_LAYOUT_STATE *pipeline_layout, |
| 428 | uint32_t first_set, uint32_t set_count, const VkDescriptorSet *pDescriptorSets, |
Jeremy Gebben | 4d51c55 | 2022-01-06 21:27:15 -0700 | [diff] [blame] | 429 | std::shared_ptr<cvdescriptorset::DescriptorSet> &push_descriptor_set, |
| 430 | uint32_t dynamic_offset_count, const uint32_t *p_dynamic_offsets); |
Jeremy Gebben | 1ec8933 | 2021-08-05 13:51:49 -0600 | [diff] [blame] | 431 | |
| 432 | void PushDescriptorSetState(VkPipelineBindPoint pipelineBindPoint, PIPELINE_LAYOUT_STATE *pipeline_layout, uint32_t set, |
| 433 | uint32_t descriptorWriteCount, const VkWriteDescriptorSet *pDescriptorWrites); |
| 434 | |
sfricke-samsung | 85584a7 | 2021-09-30 21:43:38 -0700 | [diff] [blame] | 435 | void UpdateStateCmdDrawDispatchType(CMD_TYPE cmd_type, VkPipelineBindPoint bind_point); |
| 436 | void UpdateStateCmdDrawType(CMD_TYPE cmd_type, VkPipelineBindPoint bind_point); |
| 437 | void UpdateDrawState(CMD_TYPE cmd_type, const VkPipelineBindPoint bind_point); |
Jeremy Gebben | 1ec8933 | 2021-08-05 13:51:49 -0600 | [diff] [blame] | 438 | |
Jeremy Gebben | 10a0ed1 | 2021-08-17 09:54:29 -0600 | [diff] [blame] | 439 | virtual void RecordCmd(CMD_TYPE cmd_type); |
| 440 | void RecordStateCmd(CMD_TYPE cmd_type, CBStatusFlags state_bits); |
Jeremy Gebben | 9f53710 | 2021-10-05 16:37:12 -0600 | [diff] [blame] | 441 | void RecordTransferCmd(CMD_TYPE cmd_type, std::shared_ptr<BINDABLE> &&buf1, std::shared_ptr<BINDABLE> &&buf2 = nullptr); |
Jeremy Gebben | cefa7fd | 2021-08-17 13:44:47 -0600 | [diff] [blame] | 442 | void RecordSetEvent(CMD_TYPE cmd_type, VkEvent event, VkPipelineStageFlags2KHR stageMask); |
| 443 | void RecordResetEvent(CMD_TYPE cmd_type, VkEvent event, VkPipelineStageFlags2KHR stageMask); |
Jeremy Gebben | 332d4dd | 2022-01-01 12:40:02 -0700 | [diff] [blame] | 444 | virtual void RecordWaitEvents(CMD_TYPE cmd_type, uint32_t eventCount, const VkEvent *pEvents, |
| 445 | VkPipelineStageFlags2KHR src_stage_mask); |
Jeremy Gebben | cefa7fd | 2021-08-17 13:44:47 -0600 | [diff] [blame] | 446 | void RecordWriteTimestamp(CMD_TYPE cmd_type, VkPipelineStageFlags2KHR pipelineStage, VkQueryPool queryPool, uint32_t slot); |
| 447 | |
| 448 | void RecordBarriers(uint32_t memoryBarrierCount, const VkMemoryBarrier *pMemoryBarriers, uint32_t bufferMemoryBarrierCount, |
| 449 | const VkBufferMemoryBarrier *pBufferMemoryBarriers, uint32_t imageMemoryBarrierCount, |
| 450 | const VkImageMemoryBarrier *pImageMemoryBarriers); |
| 451 | void RecordBarriers(const VkDependencyInfoKHR &dep_info); |
Jeremy Gebben | 10a0ed1 | 2021-08-17 09:54:29 -0600 | [diff] [blame] | 452 | |
Jeremy Gebben | 1ec8933 | 2021-08-05 13:51:49 -0600 | [diff] [blame] | 453 | void SetImageViewLayout(const IMAGE_VIEW_STATE &view_state, VkImageLayout layout, VkImageLayout layoutStencil); |
| 454 | void SetImageViewInitialLayout(const IMAGE_VIEW_STATE &view_state, VkImageLayout layout); |
| 455 | |
| 456 | void SetImageLayout(const IMAGE_STATE &image_state, const VkImageSubresourceRange &image_subresource_range, |
| 457 | VkImageLayout layout, VkImageLayout expected_layout = kInvalidLayout); |
| 458 | void SetImageLayout(const IMAGE_STATE &image_state, const VkImageSubresourceLayers &image_subresource_layers, |
| 459 | VkImageLayout layout); |
| 460 | void SetImageInitialLayout(VkImage image, const VkImageSubresourceRange &range, VkImageLayout layout); |
| 461 | void SetImageInitialLayout(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range, VkImageLayout layout); |
| 462 | void SetImageInitialLayout(const IMAGE_STATE &image_state, const VkImageSubresourceLayers &layers, VkImageLayout layout); |
| 463 | |
Jeremy Gebben | 5764298 | 2021-09-14 14:14:55 -0600 | [diff] [blame] | 464 | void Submit(uint32_t perf_submit_pass); |
ziga-lunarg | 96c7d82 | 2022-02-28 19:39:17 +0100 | [diff] [blame^] | 465 | void Retire(uint32_t perf_submit_pass, const std::function<bool(const QueryObject &)> &is_query_updated_after); |
Jeremy Gebben | 5764298 | 2021-09-14 14:14:55 -0600 | [diff] [blame] | 466 | |
amhagan | a448ea5 | 2021-11-02 14:09:14 -0400 | [diff] [blame] | 467 | uint32_t GetDynamicColorAttachmentCount() { |
| 468 | if (activeRenderPass) { |
| 469 | if (activeRenderPass->use_dynamic_rendering_inherited) { |
| 470 | return activeRenderPass->inheritance_rendering_info.colorAttachmentCount; |
| 471 | } |
| 472 | if (activeRenderPass->use_dynamic_rendering) { |
Aaron Hagan | 92a44f8 | 2021-11-19 09:34:56 -0500 | [diff] [blame] | 473 | return activeRenderPass->dynamic_rendering_begin_rendering_info.colorAttachmentCount; |
amhagan | a448ea5 | 2021-11-02 14:09:14 -0400 | [diff] [blame] | 474 | } |
| 475 | } |
| 476 | return 0; |
| 477 | } |
| 478 | uint32_t GetDynamicColorAttachmentImageIndex(uint32_t index) { return index; } |
| 479 | uint32_t GetDynamicColorResolveAttachmentImageIndex(uint32_t index) { return index + GetDynamicColorAttachmentCount(); } |
| 480 | uint32_t GetDynamicDepthAttachmentImageIndex() { return 2 * GetDynamicColorAttachmentCount(); } |
| 481 | uint32_t GetDynamicDepthResolveAttachmentImageIndex() { return 2 * GetDynamicColorAttachmentCount() + 1; } |
| 482 | uint32_t GetDynamicStencilAttachmentImageIndex() { return 2 * GetDynamicColorAttachmentCount() + 2; } |
| 483 | uint32_t GetDynamicStencilResolveAttachmentImageIndex() { return 2 * GetDynamicColorAttachmentCount() + 3; } |
| 484 | |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 485 | protected: |
Jeremy Gebben | c9a2403 | 2021-11-02 11:36:08 -0600 | [diff] [blame] | 486 | void NotifyInvalidate(const BASE_NODE::NodeList &invalid_nodes, bool unlink) override; |
Jeremy Gebben | 1ec8933 | 2021-08-05 13:51:49 -0600 | [diff] [blame] | 487 | void UpdateAttachmentsView(const VkRenderPassBeginInfo *pRenderPassBegin); |
aitor-lunarg | a131fca | 2022-02-17 22:55:55 +0100 | [diff] [blame] | 488 | void UnbindResources(); |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 489 | }; |
Jeremy Gebben | 7ba5615 | 2021-06-18 10:40:10 -0600 | [diff] [blame] | 490 | |
| 491 | // specializations for barriers that cannot do queue family ownership transfers |
| 492 | template <> |
| 493 | inline bool CMD_BUFFER_STATE::IsReleaseOp(const VkMemoryBarrier &barrier) const { |
| 494 | return false; |
| 495 | } |
| 496 | template <> |
| 497 | inline bool CMD_BUFFER_STATE::IsReleaseOp(const VkMemoryBarrier2KHR &barrier) const { |
| 498 | return false; |
| 499 | } |
| 500 | template <> |
| 501 | inline bool CMD_BUFFER_STATE::IsReleaseOp(const VkSubpassDependency2 &barrier) const { |
| 502 | return false; |
| 503 | } |
| 504 | template <> |
| 505 | inline bool CMD_BUFFER_STATE::IsAcquireOp(const VkMemoryBarrier &barrier) const { |
| 506 | return false; |
| 507 | } |
| 508 | template <> |
| 509 | inline bool CMD_BUFFER_STATE::IsAcquireOp(const VkMemoryBarrier2KHR &barrier) const { |
| 510 | return false; |
| 511 | } |
| 512 | template <> |
| 513 | inline bool CMD_BUFFER_STATE::IsAcquireOp(const VkSubpassDependency2 &barrier) const { |
| 514 | return false; |
| 515 | } |