| /* |
| * Vulkan |
| * |
| * Copyright (C) 2014 LunarG, Inc. |
| * |
| * Permission is hereby granted, free of charge, to any person obtaining a |
| * copy of this software and associated documentation files (the "Software"), |
| * to deal in the Software without restriction, including without limitation |
| * the rights to use, copy, modify, merge, publish, distribute, sublicense, |
| * and/or sell copies of the Software, and to permit persons to whom the |
| * Software is furnished to do so, subject to the following conditions: |
| * |
| * The above copyright notice and this permission notice shall be included |
| * in all copies or substantial portions of the Software. |
| * |
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
| * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
| * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
| * DEALINGS IN THE SOFTWARE. |
| */ |
| #include "vk_layer.h" |
| #include <vector> |
| #include <memory> |
| #include "vk_debug_report_lunarg.h" |
| |
| using namespace std; |
| |
| // Draw State ERROR codes |
| typedef enum _DRAW_STATE_ERROR |
| { |
| DRAWSTATE_NONE, // Used for INFO & other non-error messages |
| DRAWSTATE_INTERNAL_ERROR, // Error with DrawState internal data structures |
| DRAWSTATE_NO_PIPELINE_BOUND, // Unable to identify a bound pipeline |
| DRAWSTATE_INVALID_POOL, // Invalid DS pool |
| DRAWSTATE_INVALID_SET, // Invalid DS |
| DRAWSTATE_INVALID_LAYOUT, // Invalid DS layout |
| DRAWSTATE_INVALID_PIPELINE, // Invalid Pipeline handle referenced |
| DRAWSTATE_INVALID_PIPELINE_CREATE_STATE, // Attempt to create a pipeline with invalid state |
| DRAWSTATE_INVALID_COMMAND_BUFFER, // Invalid CommandBuffer referenced |
| DRAWSTATE_VTX_INDEX_OUT_OF_BOUNDS, // binding in vkCmdBindVertexData() too large for PSO's pVertexBindingDescriptions array |
| DRAWSTATE_VTX_INDEX_ALIGNMENT_ERROR, // binding offset in vkCmdBindIndexBuffer() out of alignment based on indexType |
| //DRAWSTATE_MISSING_DOT_PROGRAM, // No "dot" program in order to generate png image |
| DRAWSTATE_OUT_OF_MEMORY, // malloc failed |
| DRAWSTATE_DESCRIPTOR_TYPE_MISMATCH, // Type in layout vs. update are not the same |
| DRAWSTATE_DESCRIPTOR_STAGEFLAGS_MISMATCH, // StageFlags in layout are not the same throughout a single VkWriteDescriptorSet update |
| DRAWSTATE_DESCRIPTOR_UPDATE_OUT_OF_BOUNDS, // Descriptors set for update out of bounds for corresponding layout section |
| DRAWSTATE_DESCRIPTOR_POOL_EMPTY, // Attempt to allocate descriptor from a pool with no more descriptors of that type available |
| DRAWSTATE_CANT_FREE_FROM_NON_FREE_POOL, // Invalid to call vkFreeDescriptorSets on Sets allocated from a NON_FREE Pool |
| DRAWSTATE_INVALID_UPDATE_INDEX, // Index of requested update is invalid for specified descriptors set |
| DRAWSTATE_INVALID_UPDATE_STRUCT, // Struct in DS Update tree is of invalid type |
| DRAWSTATE_NUM_SAMPLES_MISMATCH, // Number of samples in bound PSO does not match number in FB of current RenderPass |
| DRAWSTATE_NO_END_COMMAND_BUFFER, // Must call vkEndCommandBuffer() before QueueSubmit on that commandBuffer |
| DRAWSTATE_NO_BEGIN_COMMAND_BUFFER, // Binding cmds or calling End on CB that never had vkBeginCommandBuffer() called on it |
| DRAWSTATE_COMMAND_BUFFER_SINGLE_SUBMIT_VIOLATION, // Cmd Buffer created with VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT flag is submitted multiple times |
| DRAWSTATE_INVALID_SECONDARY_COMMAND_BUFFER, // vkCmdExecuteCommands() called with a primary commandBuffer in pCommandBuffers array |
| DRAWSTATE_VIEWPORT_NOT_BOUND, // Draw submitted with no viewport state bound |
| DRAWSTATE_SCISSOR_NOT_BOUND, // Draw submitted with no scissor state bound |
| DRAWSTATE_LINE_WIDTH_NOT_BOUND, // Draw submitted with no line width state bound |
| DRAWSTATE_DEPTH_BIAS_NOT_BOUND, // Draw submitted with no depth bias state bound |
| DRAWSTATE_BLEND_NOT_BOUND, // Draw submitted with no blend state bound when color write enabled |
| DRAWSTATE_DEPTH_BOUNDS_NOT_BOUND, // Draw submitted with no depth bounds state bound when depth enabled |
| DRAWSTATE_STENCIL_NOT_BOUND, // Draw submitted with no stencil state bound when stencil enabled |
| DRAWSTATE_INDEX_BUFFER_NOT_BOUND, // Draw submitted with no depth-stencil state bound when depth write enabled |
| DRAWSTATE_PIPELINE_LAYOUT_MISMATCH, // Draw submitted PSO Pipeline layout that doesn't match layout from BindDescriptorSets |
| DRAWSTATE_INVALID_RENDERPASS, // Use of a NULL or otherwise invalid RenderPass object |
| DRAWSTATE_INVALID_RENDERPASS_CMD, // Invalid cmd submitted while a RenderPass is active |
| DRAWSTATE_NO_ACTIVE_RENDERPASS, // Rendering cmd submitted without an active RenderPass |
| DRAWSTATE_DESCRIPTOR_SET_NOT_UPDATED, // DescriptorSet bound but it was never updated. This is a warning code. |
| DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, // Clear cmd issued before any Draw in CommandBuffer, should use RenderPass Ops instead |
| DRAWSTATE_BEGIN_CB_INVALID_STATE, // Primary/Secondary CB created with mismatched FB/RP information |
| DRAWSTATE_VIEWPORT_SCISSOR_MISMATCH, // Count for viewports and scissors mismatch and/or state doesn't match count |
| DRAWSTATE_INVALID_IMAGE_ASPECT, // Image aspect is invalid for the current operation |
| DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, // Attachment reference must be present in active subpass |
| DRAWSTATE_INVALID_EXTENSION, |
| DRAWSTATE_SAMPLER_DESCRIPTOR_ERROR, // A Descriptor of *_SAMPLER type is being updated with an invalid or bad Sampler |
| DRAWSTATE_INCONSISTENT_IMMUTABLE_SAMPLER_UPDATE, // Descriptors of *COMBINED_IMAGE_SAMPLER type are being updated where some, but not all, of the updates use immutable samplers |
| DRAWSTATE_IMAGEVIEW_DESCRIPTOR_ERROR, // A Descriptor of *_IMAGE or *_ATTACHMENT type is being updated with an invalid or bad ImageView |
| DRAWSTATE_BUFFERVIEW_DESCRIPTOR_ERROR, // A Descriptor of *_TEXEL_BUFFER type is being updated with an invalid or bad BufferView |
| DRAWSTATE_BUFFERINFO_DESCRIPTOR_ERROR, // A Descriptor of *_[UNIFORM|STORAGE]_BUFFER_[DYNAMIC] type is being updated with an invalid or bad BufferView |
| } DRAW_STATE_ERROR; |
| |
| typedef enum _DRAW_TYPE |
| { |
| DRAW = 0, |
| DRAW_INDEXED = 1, |
| DRAW_INDIRECT = 2, |
| DRAW_INDEXED_INDIRECT = 3, |
| DRAW_BEGIN_RANGE = DRAW, |
| DRAW_END_RANGE = DRAW_INDEXED_INDIRECT, |
| NUM_DRAW_TYPES = (DRAW_END_RANGE - DRAW_BEGIN_RANGE + 1), |
| } DRAW_TYPE; |
| |
| typedef struct _SHADER_DS_MAPPING { |
| uint32_t slotCount; |
| VkDescriptorSetLayoutCreateInfo* pShaderMappingSlot; |
| } SHADER_DS_MAPPING; |
| |
| typedef struct _GENERIC_HEADER { |
| VkStructureType sType; |
| const void* pNext; |
| } GENERIC_HEADER; |
| |
| typedef struct _PIPELINE_NODE { |
| VkPipeline pipeline; |
| VkGraphicsPipelineCreateInfo graphicsPipelineCI; |
| VkPipelineVertexInputStateCreateInfo vertexInputCI; |
| VkPipelineInputAssemblyStateCreateInfo iaStateCI; |
| VkPipelineTessellationStateCreateInfo tessStateCI; |
| VkPipelineViewportStateCreateInfo vpStateCI; |
| VkPipelineRasterizationStateCreateInfo rsStateCI; |
| VkPipelineMultisampleStateCreateInfo msStateCI; |
| VkPipelineColorBlendStateCreateInfo cbStateCI; |
| VkPipelineDepthStencilStateCreateInfo dsStateCI; |
| VkPipelineDynamicStateCreateInfo dynStateCI; |
| VkPipelineShaderStageCreateInfo vsCI; |
| VkPipelineShaderStageCreateInfo tcsCI; |
| VkPipelineShaderStageCreateInfo tesCI; |
| VkPipelineShaderStageCreateInfo gsCI; |
| VkPipelineShaderStageCreateInfo fsCI; |
| // Compute shader is include in VkComputePipelineCreateInfo |
| VkComputePipelineCreateInfo computePipelineCI; |
| // Flag of which shader stages are active for this pipeline |
| uint32_t active_shaders; |
| // Vtx input info (if any) |
| uint32_t vtxBindingCount; // number of bindings |
| VkVertexInputBindingDescription* pVertexBindingDescriptions; |
| uint32_t vtxAttributeCount; // number of attributes |
| VkVertexInputAttributeDescription* pVertexAttributeDescriptions; |
| uint32_t attachmentCount; // number of CB attachments |
| VkPipelineColorBlendAttachmentState* pAttachments; |
| } PIPELINE_NODE; |
| |
| typedef struct _SAMPLER_NODE { |
| VkSampler sampler; |
| VkSamplerCreateInfo createInfo; |
| |
| _SAMPLER_NODE(const VkSampler* ps, const VkSamplerCreateInfo* pci) : sampler(*ps), createInfo(*pci) {}; |
| } SAMPLER_NODE; |
| // Descriptor Data structures |
| // Layout Node has the core layout data |
| typedef struct _LAYOUT_NODE { |
| VkDescriptorSetLayout layout; |
| VkDescriptorSetLayoutCreateInfo createInfo; |
| uint32_t startIndex; // 1st index of this layout |
| uint32_t endIndex; // last index of this layout |
| vector<VkDescriptorType> descriptorTypes; // Type per descriptor in this layout to verify correct updates |
| vector<VkShaderStageFlags> stageFlags; // stageFlags per descriptor in this layout to verify correct updates |
| } LAYOUT_NODE; |
| // Store layouts and pushconstants for PipelineLayout |
| struct PIPELINE_LAYOUT_NODE { |
| vector<VkDescriptorSetLayout> descriptorSetLayouts; |
| vector<VkPushConstantRange> pushConstantRanges; |
| }; |
| |
| typedef struct _SET_NODE { |
| VkDescriptorSet set; |
| VkDescriptorPool pool; |
| // Head of LL of all Update structs for this set |
| GENERIC_HEADER* pUpdateStructs; |
| // Total num of descriptors in this set (count of its layout plus all prior layouts) |
| uint32_t descriptorCount; |
| GENERIC_HEADER** ppDescriptors; // Array where each index points to update node for its slot |
| LAYOUT_NODE* pLayout; // Layout for this set |
| struct _SET_NODE* pNext; |
| } SET_NODE; |
| |
| typedef struct _POOL_NODE { |
| VkDescriptorPool pool; |
| uint32_t maxSets; |
| VkDescriptorPoolCreateInfo createInfo; |
| SET_NODE* pSets; // Head of LL of sets for this Pool |
| vector<uint32_t> maxDescriptorTypeCount; // max # of descriptors of each type in this pool |
| vector<uint32_t> availableDescriptorTypeCount; // available # of descriptors of each type in this pool |
| |
| _POOL_NODE(const VkDescriptorPool pool, const VkDescriptorPoolCreateInfo* pCreateInfo) : |
| pool(pool), createInfo(*pCreateInfo), maxSets(pCreateInfo->maxSets), pSets(NULL), |
| maxDescriptorTypeCount(VK_DESCRIPTOR_TYPE_END_RANGE), availableDescriptorTypeCount(VK_DESCRIPTOR_TYPE_END_RANGE) |
| { |
| if (createInfo.typeCount) { // Shadow type struct from ptr into local struct |
| size_t typeCountSize = createInfo.typeCount * sizeof(VkDescriptorTypeCount); |
| createInfo.pTypeCounts = new VkDescriptorTypeCount[typeCountSize]; |
| memcpy((void*)createInfo.pTypeCounts, pCreateInfo->pTypeCounts, typeCountSize); |
| // Now set max counts for each descriptor type based on count of that type times maxSets |
| int32_t i=0; |
| for (i=0; i<createInfo.typeCount; ++i) { |
| uint32_t typeIndex = static_cast<uint32_t>(createInfo.pTypeCounts[i].type); |
| uint32_t typeCount = createInfo.pTypeCounts[i].descriptorCount; |
| maxDescriptorTypeCount[typeIndex] += typeCount; |
| } |
| for (i=0; i<maxDescriptorTypeCount.size(); ++i) { |
| maxDescriptorTypeCount[i] *= createInfo.maxSets; |
| // Initially the available counts are equal to the max counts |
| availableDescriptorTypeCount[i] = maxDescriptorTypeCount[i]; |
| } |
| } else { |
| createInfo.pTypeCounts = NULL; // Make sure this is NULL so we don't try to clean it up |
| } |
| } |
| ~_POOL_NODE() { |
| if (createInfo.pTypeCounts) { |
| delete[] createInfo.pTypeCounts; |
| } |
| // TODO : pSets are currently freed in deletePools function which uses freeShadowUpdateTree function |
| // need to migrate that struct to smart ptrs for auto-cleanup |
| } |
| } POOL_NODE; |
| |
| // Cmd Buffer Tracking |
| typedef enum _CMD_TYPE |
| { |
| CMD_BINDPIPELINE, |
| CMD_BINDPIPELINEDELTA, |
| CMD_SETVIEWPORTSTATE, |
| CMD_SETSCISSORSTATE, |
| CMD_SETLINEWIDTHSTATE, |
| CMD_SETDEPTHBIASSTATE, |
| CMD_SETBLENDSTATE, |
| CMD_SETDEPTHBOUNDSSTATE, |
| CMD_SETSTENCILREADMASKSTATE, |
| CMD_SETSTENCILWRITEMASKSTATE, |
| CMD_SETSTENCILREFERENCESTATE, |
| CMD_BINDDESCRIPTORSETS, |
| CMD_BINDINDEXBUFFER, |
| CMD_BINDVERTEXBUFFER, |
| CMD_DRAW, |
| CMD_DRAWINDEXED, |
| CMD_DRAWINDIRECT, |
| CMD_DRAWINDEXEDINDIRECT, |
| CMD_DISPATCH, |
| CMD_DISPATCHINDIRECT, |
| CMD_COPYBUFFER, |
| CMD_COPYIMAGE, |
| CMD_BLITIMAGE, |
| CMD_COPYBUFFERTOIMAGE, |
| CMD_COPYIMAGETOBUFFER, |
| CMD_CLONEIMAGEDATA, |
| CMD_UPDATEBUFFER, |
| CMD_FILLBUFFER, |
| CMD_CLEARCOLORIMAGE, |
| CMD_CLEARATTACHMENTS, |
| CMD_CLEARDEPTHSTENCILIMAGE, |
| CMD_RESOLVEIMAGE, |
| CMD_SETEVENT, |
| CMD_RESETEVENT, |
| CMD_WAITEVENTS, |
| CMD_PIPELINEBARRIER, |
| CMD_BEGINQUERY, |
| CMD_ENDQUERY, |
| CMD_RESETQUERYPOOL, |
| CMD_COPYQUERYPOOLRESULTS, |
| CMD_WRITETIMESTAMP, |
| CMD_INITATOMICCOUNTERS, |
| CMD_LOADATOMICCOUNTERS, |
| CMD_SAVEATOMICCOUNTERS, |
| CMD_BEGINRENDERPASS, |
| CMD_NEXTSUBPASS, |
| CMD_ENDRENDERPASS, |
| CMD_EXECUTECOMMANDS, |
| CMD_DBGMARKERBEGIN, |
| CMD_DBGMARKEREND, |
| } CMD_TYPE; |
| // Data structure for holding sequence of cmds in cmd buffer |
| typedef struct _CMD_NODE { |
| CMD_TYPE type; |
| uint64_t cmdNumber; |
| } CMD_NODE; |
| |
| typedef enum _CB_STATE |
| { |
| CB_NEW, // Newly created CB w/o any cmds |
| CB_UPDATE_ACTIVE, // BeginCB has been called on this CB |
| CB_UPDATE_COMPLETE // EndCB has been called on this CB |
| } CB_STATE; |
| // CB Status -- used to track status of various bindings on cmd buffer objects |
| typedef VkFlags CBStatusFlags; |
| typedef enum _CBStatusFlagBits |
| { |
| CBSTATUS_NONE = 0x00000000, // No status is set |
| CBSTATUS_VIEWPORT_SET = 0x00000001, // Viewport has been set |
| CBSTATUS_LINE_WIDTH_SET = 0x00000002, // Line width has been set |
| CBSTATUS_DEPTH_BIAS_SET = 0x00000004, // Depth bias has been set |
| CBSTATUS_COLOR_BLEND_WRITE_ENABLE = 0x00000008, // PSO w/ CB Enable set has been set |
| CBSTATUS_BLEND_SET = 0x00000010, // Blend state object has been set |
| CBSTATUS_DEPTH_WRITE_ENABLE = 0x00000020, // PSO w/ Depth Enable set has been set |
| CBSTATUS_STENCIL_TEST_ENABLE = 0x00000040, // PSO w/ Stencil Enable set has been set |
| CBSTATUS_DEPTH_BOUNDS_SET = 0x00000080, // Depth bounds state object has been set |
| CBSTATUS_STENCIL_READ_MASK_SET = 0x00000100, // Stencil read mask has been set |
| CBSTATUS_STENCIL_WRITE_MASK_SET = 0x00000200, // Stencil write mask has been set |
| CBSTATUS_STENCIL_REFERENCE_SET = 0x00000400, // Stencil reference has been set |
| CBSTATUS_INDEX_BUFFER_BOUND = 0x00000800, // Index buffer has been set |
| CBSTATUS_SCISSOR_SET = 0x00001000, // Scissor has been set |
| CBSTATUS_ALL = 0x00001FFF, // All dynamic state set |
| } CBStatusFlagBits; |
| |
| typedef struct stencil_data { |
| uint32_t stencilCompareMask; |
| uint32_t stencilWriteMask; |
| uint32_t stencilReference; |
| } CBStencilData; |
| |
| // Cmd Buffer Wrapper Struct |
| typedef struct _GLOBAL_CB_NODE { |
| VkCommandBuffer commandBuffer; |
| VkCommandBufferAllocateInfo createInfo; |
| VkCommandBufferBeginInfo beginInfo; |
| VkFence fence; // fence tracking this cmd buffer |
| uint64_t numCmds; // number of cmds in this CB |
| uint64_t drawCount[NUM_DRAW_TYPES]; // Count of each type of draw in this CB |
| CB_STATE state; // Track cmd buffer update state |
| uint64_t submitCount; // Number of times CB has been submitted |
| CBStatusFlags status; // Track status of various bindings on cmd buffer |
| vector<CMD_NODE*> pCmds; |
| // Currently storing "lastBound" objects on per-CB basis |
| // long-term may want to create caches of "lastBound" states and could have |
| // each individual CMD_NODE referencing its own "lastBound" state |
| VkPipeline lastBoundPipeline; |
| uint32_t lastVtxBinding; |
| vector<VkViewport> viewports; |
| vector<VkRect2D> scissors; |
| float lineWidth; |
| float depthBiasConstantFactor; |
| float depthBiasClamp; |
| float depthBiasSlopeFactor; |
| float blendConstants[4]; |
| float minDepthBounds; |
| float maxDepthBounds; |
| CBStencilData front; |
| CBStencilData back; |
| VkDescriptorSet lastBoundDescriptorSet; |
| VkPipelineLayout lastBoundPipelineLayout; |
| VkRenderPass activeRenderPass; |
| uint32_t activeSubpass; |
| VkFramebuffer framebuffer; |
| VkCommandBufferLevel level; |
| vector<VkDescriptorSet> boundDescriptorSets; |
| } GLOBAL_CB_NODE; |