blob: 9cfb07c60c82c90591d24ec8bdbbab519b01b016 [file] [log] [blame]
Tobin Ehlis246ba4d2014-11-18 16:38:08 -07001/*
Tobin Ehlis246ba4d2014-11-18 16:38:08 -07002 *
Courtney Goeltzenleuchterfcbe16f2015-10-29 13:50:34 -06003 * Copyright (C) 2015 Valve Corporation
Tobin Ehlis7e2ad752015-12-01 09:48:58 -07004 * Copyright (C) 2015 Google, Inc.
Tobin Ehlis246ba4d2014-11-18 16:38:08 -07005 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included
14 * in all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
Courtney Goeltzenleuchter05559522015-10-30 11:14:30 -060023 *
Tobin Ehlis7e2ad752015-12-01 09:48:58 -070024 * Author: Courtney Goeltzenleuchter <courtneygo@google.com>
25 * Author: Tobin Ehlis <tobine@google.com>
26 * Author: Chris Forbes <chrisf@ijw.co.nz>
Tobin Ehlis246ba4d2014-11-18 16:38:08 -070027 */
David Pinedo9316d3b2015-11-06 12:54:48 -070028#include "vulkan/vk_layer.h"
Courtney Goeltzenleuchter7415d5a2015-12-09 15:48:16 -070029#include "vulkan/vk_ext_debug_report.h"
Tobin Ehlis10ae8c12015-03-17 16:24:32 -060030#include <vector>
Tobin Ehlisb212dfc2015-10-07 15:40:22 -060031#include <memory>
Tobin Ehlis10ae8c12015-03-17 16:24:32 -060032
Tobin Ehlis7e2ad752015-12-01 09:48:58 -070033using std::vector;
34
Tobin Ehlis246ba4d2014-11-18 16:38:08 -070035// Draw State ERROR codes
36typedef enum _DRAW_STATE_ERROR
37{
Tobin Ehlis7265e832015-01-19 08:42:29 -070038 DRAWSTATE_NONE, // Used for INFO & other non-error messages
Tobin Ehlis04178d72015-01-22 10:45:21 -070039 DRAWSTATE_INTERNAL_ERROR, // Error with DrawState internal data structures
Tobin Ehlis7265e832015-01-19 08:42:29 -070040 DRAWSTATE_NO_PIPELINE_BOUND, // Unable to identify a bound pipeline
Tobin Ehlis793ad302015-04-03 12:01:11 -060041 DRAWSTATE_INVALID_POOL, // Invalid DS pool
Tobin Ehlisa3a693e2015-02-10 15:35:23 -070042 DRAWSTATE_INVALID_SET, // Invalid DS
Tobin Ehlis04178d72015-01-22 10:45:21 -070043 DRAWSTATE_INVALID_LAYOUT, // Invalid DS layout
Michael Lentineabc5e922015-10-12 11:30:14 -050044 DRAWSTATE_INVALID_IMAGE_LAYOUT, // Invalid Image layout
Tobin Ehlis75283bf2015-06-18 15:59:33 -060045 DRAWSTATE_INVALID_PIPELINE, // Invalid Pipeline handle referenced
Tobin Ehlis559c6382015-11-05 09:52:49 -070046 DRAWSTATE_INVALID_PIPELINE_LAYOUT, // Invalid PipelineLayout
Tobin Ehlis75283bf2015-06-18 15:59:33 -060047 DRAWSTATE_INVALID_PIPELINE_CREATE_STATE, // Attempt to create a pipeline with invalid state
Michael Lentine48930b82015-10-15 17:07:00 -050048 DRAWSTATE_INVALID_COMMAND_BUFFER, // Invalid CommandBuffer referenced
49 DRAWSTATE_INVALID_BARRIER, // Invalid Barrier
Courtney Goeltzenleuchterd8e229c2015-04-08 15:36:08 -060050 DRAWSTATE_VTX_INDEX_OUT_OF_BOUNDS, // binding in vkCmdBindVertexData() too large for PSO's pVertexBindingDescriptions array
Tobin Ehlisc4c23182015-09-17 12:24:13 -060051 DRAWSTATE_VTX_INDEX_ALIGNMENT_ERROR, // binding offset in vkCmdBindIndexBuffer() out of alignment based on indexType
Tobin Ehlis12d4c6a2015-08-31 12:42:38 -060052 //DRAWSTATE_MISSING_DOT_PROGRAM, // No "dot" program in order to generate png image
Tobin Ehlis04178d72015-01-22 10:45:21 -070053 DRAWSTATE_OUT_OF_MEMORY, // malloc failed
54 DRAWSTATE_DESCRIPTOR_TYPE_MISMATCH, // Type in layout vs. update are not the same
Tobin Ehlisa1f9b642015-10-27 12:25:35 -060055 DRAWSTATE_DESCRIPTOR_STAGEFLAGS_MISMATCH, // StageFlags in layout are not the same throughout a single VkWriteDescriptorSet update
Tobin Ehlisa3a693e2015-02-10 15:35:23 -070056 DRAWSTATE_DESCRIPTOR_UPDATE_OUT_OF_BOUNDS, // Descriptors set for update out of bounds for corresponding layout section
Tobin Ehlisf93f1e32015-10-20 16:16:04 -060057 DRAWSTATE_DESCRIPTOR_POOL_EMPTY, // Attempt to allocate descriptor from a pool with no more descriptors of that type available
Courtney Goeltzenleuchterbee18a92015-10-23 14:21:05 -060058 DRAWSTATE_CANT_FREE_FROM_NON_FREE_POOL, // Invalid to call vkFreeDescriptorSets on Sets allocated from a NON_FREE Pool
Tobin Ehlis297b9852015-02-23 16:09:58 -070059 DRAWSTATE_INVALID_UPDATE_INDEX, // Index of requested update is invalid for specified descriptors set
Tobin Ehliseba312c2015-04-01 08:40:34 -060060 DRAWSTATE_INVALID_UPDATE_STRUCT, // Struct in DS Update tree is of invalid type
Tobin Ehlisa9f3d762015-05-22 12:38:16 -060061 DRAWSTATE_NUM_SAMPLES_MISMATCH, // Number of samples in bound PSO does not match number in FB of current RenderPass
Chia-I Wu3432a0c2015-10-27 18:04:07 +080062 DRAWSTATE_NO_END_COMMAND_BUFFER, // Must call vkEndCommandBuffer() before QueueSubmit on that commandBuffer
63 DRAWSTATE_NO_BEGIN_COMMAND_BUFFER, // Binding cmds or calling End on CB that never had vkBeginCommandBuffer() called on it
64 DRAWSTATE_COMMAND_BUFFER_SINGLE_SUBMIT_VIOLATION, // Cmd Buffer created with VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT flag is submitted multiple times
65 DRAWSTATE_INVALID_SECONDARY_COMMAND_BUFFER, // vkCmdExecuteCommands() called with a primary commandBuffer in pCommandBuffers array
Tobin Ehlis963a4042015-09-29 08:18:34 -060066 DRAWSTATE_VIEWPORT_NOT_BOUND, // Draw submitted with no viewport state bound
67 DRAWSTATE_SCISSOR_NOT_BOUND, // Draw submitted with no scissor state bound
68 DRAWSTATE_LINE_WIDTH_NOT_BOUND, // Draw submitted with no line width state bound
69 DRAWSTATE_DEPTH_BIAS_NOT_BOUND, // Draw submitted with no depth bias state bound
70 DRAWSTATE_BLEND_NOT_BOUND, // Draw submitted with no blend state bound when color write enabled
71 DRAWSTATE_DEPTH_BOUNDS_NOT_BOUND, // Draw submitted with no depth bounds state bound when depth enabled
72 DRAWSTATE_STENCIL_NOT_BOUND, // Draw submitted with no stencil state bound when stencil enabled
73 DRAWSTATE_INDEX_BUFFER_NOT_BOUND, // Draw submitted with no depth-stencil state bound when depth write enabled
Tobin Ehlis559c6382015-11-05 09:52:49 -070074 DRAWSTATE_PIPELINE_LAYOUTS_INCOMPATIBLE, // Draw submitted PSO Pipeline layout that's not compatible with layout from BindDescriptorSets
Tobin Ehlis651d9b02015-12-16 05:01:22 -070075 DRAWSTATE_RENDERPASS_INCOMPATIBLE, // Incompatible renderpasses between secondary cmdBuffer and primary cmdBuffer or framebuffer
76 DRAWSTATE_FRAMEBUFFER_INCOMPATIBLE, // Incompatible framebuffer between secondary cmdBuffer and active renderPass
Tobin Ehlis259730a2015-06-23 16:13:03 -060077 DRAWSTATE_INVALID_RENDERPASS, // Use of a NULL or otherwise invalid RenderPass object
Tobin Ehlisd1fe4ec2015-06-23 11:22:55 -060078 DRAWSTATE_INVALID_RENDERPASS_CMD, // Invalid cmd submitted while a RenderPass is active
79 DRAWSTATE_NO_ACTIVE_RENDERPASS, // Rendering cmd submitted without an active RenderPass
Tobin Ehlis502480b2015-06-24 15:53:07 -060080 DRAWSTATE_DESCRIPTOR_SET_NOT_UPDATED, // DescriptorSet bound but it was never updated. This is a warning code.
Tobin Ehlis88452832015-12-03 09:40:56 -070081 DRAWSTATE_DESCRIPTOR_SET_NOT_BOUND, // DescriptorSet used by pipeline at draw time is not bound, or has been disturbed (which would have flagged previous warning)
Tobin Ehlisda2f0d02015-11-04 12:28:28 -070082 DRAWSTATE_INVALID_DYNAMIC_OFFSET_COUNT, // DescriptorSets bound with different number of dynamic descriptors that were included in dynamicOffsetCount
Chia-I Wu3432a0c2015-10-27 18:04:07 +080083 DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, // Clear cmd issued before any Draw in CommandBuffer, should use RenderPass Ops instead
Tobin Ehlisac0ef842015-12-14 13:46:38 -070084 DRAWSTATE_BEGIN_CB_INVALID_STATE, // CB state at Begin call is bad. Can be Primary/Secondary CB created with mismatched FB/RP information or CB in RECORDING state
85 DRAWSTATE_INVALID_COMMAND_BUFFER_RESET, // Attempting to call Reset (or Begin on recorded cmdBuffer) that was allocated from Pool w/o VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT bit set
Tobin Ehlise68360f2015-10-01 11:15:13 -060086 DRAWSTATE_VIEWPORT_SCISSOR_MISMATCH, // Count for viewports and scissors mismatch and/or state doesn't match count
Mark Lobodzinskif53c6e52015-10-16 13:32:24 -060087 DRAWSTATE_INVALID_IMAGE_ASPECT, // Image aspect is invalid for the current operation
Mark Lobodzinski13ec6b02015-10-16 09:17:27 -060088 DRAWSTATE_MISSING_ATTACHMENT_REFERENCE, // Attachment reference must be present in active subpass
Tobin Ehlis75283bf2015-06-18 15:59:33 -060089 DRAWSTATE_INVALID_EXTENSION,
Tobin Ehlisa1c28562015-10-23 16:00:08 -060090 DRAWSTATE_SAMPLER_DESCRIPTOR_ERROR, // A Descriptor of *_SAMPLER type is being updated with an invalid or bad Sampler
Tobin Ehlisa1f9b642015-10-27 12:25:35 -060091 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
Tobin Ehlisa1c28562015-10-23 16:00:08 -060092 DRAWSTATE_IMAGEVIEW_DESCRIPTOR_ERROR, // A Descriptor of *_IMAGE or *_ATTACHMENT type is being updated with an invalid or bad ImageView
93 DRAWSTATE_BUFFERVIEW_DESCRIPTOR_ERROR, // A Descriptor of *_TEXEL_BUFFER type is being updated with an invalid or bad BufferView
94 DRAWSTATE_BUFFERINFO_DESCRIPTOR_ERROR, // A Descriptor of *_[UNIFORM|STORAGE]_BUFFER_[DYNAMIC] type is being updated with an invalid or bad BufferView
Tobin Ehlis246ba4d2014-11-18 16:38:08 -070095} DRAW_STATE_ERROR;
Tobin Ehlis5742e772014-11-20 09:49:17 -070096
Mark Lobodzinski9c75c162015-12-04 10:11:56 -070097typedef enum _SHADER_CHECKER_ERROR {
98 SHADER_CHECKER_NONE,
99 SHADER_CHECKER_FS_MIXED_BROADCAST, /* FS writes broadcast output AND custom outputs */
100 SHADER_CHECKER_INTERFACE_TYPE_MISMATCH, /* Type mismatch between shader stages or shader and pipeline */
101 SHADER_CHECKER_OUTPUT_NOT_CONSUMED, /* Entry appears in output interface, but missing in input */
102 SHADER_CHECKER_INPUT_NOT_PRODUCED, /* Entry appears in input interface, but missing in output */
103 SHADER_CHECKER_NON_SPIRV_SHADER, /* Shader image is not SPIR-V */
104 SHADER_CHECKER_INCONSISTENT_SPIRV, /* General inconsistency within a SPIR-V module */
105 SHADER_CHECKER_UNKNOWN_STAGE, /* Stage is not supported by analysis */
106 SHADER_CHECKER_INCONSISTENT_VI, /* VI state contains conflicting binding or attrib descriptions */
107 SHADER_CHECKER_MISSING_DESCRIPTOR, /* Shader attempts to use a descriptor binding not declared in the layout */
108} SHADER_CHECKER_ERROR;
109
Tobin Ehlis5742e772014-11-20 09:49:17 -0700110typedef enum _DRAW_TYPE
111{
112 DRAW = 0,
113 DRAW_INDEXED = 1,
114 DRAW_INDIRECT = 2,
115 DRAW_INDEXED_INDIRECT = 3,
116 DRAW_BEGIN_RANGE = DRAW,
117 DRAW_END_RANGE = DRAW_INDEXED_INDIRECT,
118 NUM_DRAW_TYPES = (DRAW_END_RANGE - DRAW_BEGIN_RANGE + 1),
119} DRAW_TYPE;
Tobin Ehlis83562882014-11-27 15:43:39 -0700120
Tobin Ehlis7265e832015-01-19 08:42:29 -0700121typedef struct _SHADER_DS_MAPPING {
122 uint32_t slotCount;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600123 VkDescriptorSetLayoutCreateInfo* pShaderMappingSlot;
Tobin Ehlis7265e832015-01-19 08:42:29 -0700124} SHADER_DS_MAPPING;
125
Tobin Ehlis04178d72015-01-22 10:45:21 -0700126typedef struct _GENERIC_HEADER {
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600127 VkStructureType sType;
Tobin Ehlis7265e832015-01-19 08:42:29 -0700128 const void* pNext;
Tobin Ehlis04178d72015-01-22 10:45:21 -0700129} GENERIC_HEADER;
Tobin Ehlis7265e832015-01-19 08:42:29 -0700130
131typedef struct _PIPELINE_NODE {
Tony Barbourdd6e32e2015-07-10 15:29:03 -0600132 VkPipeline pipeline;
133 VkGraphicsPipelineCreateInfo graphicsPipelineCI;
134 VkPipelineVertexInputStateCreateInfo vertexInputCI;
135 VkPipelineInputAssemblyStateCreateInfo iaStateCI;
136 VkPipelineTessellationStateCreateInfo tessStateCI;
137 VkPipelineViewportStateCreateInfo vpStateCI;
Tobin Ehlis559c6382015-11-05 09:52:49 -0700138 VkPipelineRasterizationStateCreateInfo rsStateCI;
Tony Barbourdd6e32e2015-07-10 15:29:03 -0600139 VkPipelineMultisampleStateCreateInfo msStateCI;
140 VkPipelineColorBlendStateCreateInfo cbStateCI;
141 VkPipelineDepthStencilStateCreateInfo dsStateCI;
Tobin Ehlis963a4042015-09-29 08:18:34 -0600142 VkPipelineDynamicStateCreateInfo dynStateCI;
Tony Barbourdd6e32e2015-07-10 15:29:03 -0600143 VkPipelineShaderStageCreateInfo vsCI;
144 VkPipelineShaderStageCreateInfo tcsCI;
145 VkPipelineShaderStageCreateInfo tesCI;
146 VkPipelineShaderStageCreateInfo gsCI;
147 VkPipelineShaderStageCreateInfo fsCI;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600148 // Compute shader is include in VkComputePipelineCreateInfo
Mark Lobodzinskid5732f32015-06-23 15:11:57 -0600149 VkComputePipelineCreateInfo computePipelineCI;
Tobin Ehlisa85167d2015-06-18 11:02:59 -0600150 // Flag of which shader stages are active for this pipeline
Mark Lobodzinskid5732f32015-06-23 15:11:57 -0600151 uint32_t active_shaders;
Tobin Ehlis88452832015-12-03 09:40:56 -0700152 // Capture which sets are actually used by the shaders of this pipeline
153 std::set<unsigned> active_sets;
Tobin Ehlis7265e832015-01-19 08:42:29 -0700154 // Vtx input info (if any)
Mark Lobodzinskid5732f32015-06-23 15:11:57 -0600155 uint32_t vtxBindingCount; // number of bindings
156 VkVertexInputBindingDescription* pVertexBindingDescriptions;
157 uint32_t vtxAttributeCount; // number of attributes
158 VkVertexInputAttributeDescription* pVertexAttributeDescriptions;
159 uint32_t attachmentCount; // number of CB attachments
Tony Barbourdd6e32e2015-07-10 15:29:03 -0600160 VkPipelineColorBlendAttachmentState* pAttachments;
Mark Lobodzinskic44baa52015-12-11 11:56:07 -0700161 // Default constructor
162 _PIPELINE_NODE():pipeline{},
163 graphicsPipelineCI{},
164 vertexInputCI{},
165 iaStateCI{},
166 tessStateCI{},
167 vpStateCI{},
168 rsStateCI{},
169 msStateCI{},
170 cbStateCI{},
171 dsStateCI{},
172 dynStateCI{},
173 vsCI{},
174 tcsCI{},
175 tesCI{},
176 gsCI{},
177 fsCI{},
178 computePipelineCI{},
179 active_shaders(0),
180 vtxBindingCount(0),
181 pVertexBindingDescriptions(0),
182 vtxAttributeCount(0),
183 pVertexAttributeDescriptions(0),
184 attachmentCount(0),
185 pAttachments(0)
186 {};
Tobin Ehlis7265e832015-01-19 08:42:29 -0700187} PIPELINE_NODE;
188
189typedef struct _SAMPLER_NODE {
Tobin Ehlisce132d82015-06-19 15:07:05 -0600190 VkSampler sampler;
191 VkSamplerCreateInfo createInfo;
Tobin Ehlisb212dfc2015-10-07 15:40:22 -0600192
193 _SAMPLER_NODE(const VkSampler* ps, const VkSamplerCreateInfo* pci) : sampler(*ps), createInfo(*pci) {};
Tobin Ehlis7265e832015-01-19 08:42:29 -0700194} SAMPLER_NODE;
Michael Lentineabc5e922015-10-12 11:30:14 -0500195
196typedef struct _IMAGE_NODE {
197 VkImageLayout layout;
198} IMAGE_NODE;
199
200typedef struct _IMAGE_CMD_BUF_NODE {
201 VkImageLayout layout;
202 VkImageLayout initialLayout;
203} IMAGE_CMD_BUF_NODE;
204
Tobin Ehlis651d9b02015-12-16 05:01:22 -0700205struct RENDER_PASS_NODE {
Tobin Ehlis3f5ddbb2015-12-02 13:53:34 -0700206 VkRenderPassCreateInfo const* pCreateInfo;
Michael Lentine48930b82015-10-15 17:07:00 -0500207 std::vector<bool> hasSelfDependency;
Tobin Ehlis3f5ddbb2015-12-02 13:53:34 -0700208 vector<std::vector<VkFormat>> subpassColorFormats;
209
Tobin Ehlis651d9b02015-12-16 05:01:22 -0700210 RENDER_PASS_NODE(VkRenderPassCreateInfo const *pCreateInfo) : pCreateInfo(pCreateInfo)
Tobin Ehlis3f5ddbb2015-12-02 13:53:34 -0700211 {
212 uint32_t i;
213
214 subpassColorFormats.reserve(pCreateInfo->subpassCount);
215 for (i = 0; i < pCreateInfo->subpassCount; i++) {
216 const VkSubpassDescription *subpass = &pCreateInfo->pSubpasses[i];
217 vector<VkFormat> color_formats;
218 uint32_t j;
219
220 color_formats.reserve(subpass->colorAttachmentCount);
221 for (j = 0; j < subpass->colorAttachmentCount; j++) {
222 const uint32_t att = subpass->pColorAttachments[j].attachment;
223 const VkFormat format = pCreateInfo->pAttachments[att].format;
224
225 color_formats.push_back(pCreateInfo->pAttachments[att].format);
226 }
227
228 subpassColorFormats.push_back(color_formats);
229 }
230 }
Tobin Ehlis651d9b02015-12-16 05:01:22 -0700231};
Michael Lentine48930b82015-10-15 17:07:00 -0500232
Tobin Ehlis7265e832015-01-19 08:42:29 -0700233// Descriptor Data structures
Tobin Ehlis04178d72015-01-22 10:45:21 -0700234// Layout Node has the core layout data
Tobin Ehlis7265e832015-01-19 08:42:29 -0700235typedef struct _LAYOUT_NODE {
Tobin Ehlisce132d82015-06-19 15:07:05 -0600236 VkDescriptorSetLayout layout;
Tobin Ehlisce132d82015-06-19 15:07:05 -0600237 VkDescriptorSetLayoutCreateInfo createInfo;
238 uint32_t startIndex; // 1st index of this layout
239 uint32_t endIndex; // last index of this layout
Tobin Ehlisda2f0d02015-11-04 12:28:28 -0700240 uint32_t dynamicDescriptorCount; // Total count of dynamic descriptors used by this layout
Tobin Ehlis644ff042015-10-20 10:11:55 -0600241 vector<VkDescriptorType> descriptorTypes; // Type per descriptor in this layout to verify correct updates
Tobin Ehlisa1f9b642015-10-27 12:25:35 -0600242 vector<VkShaderStageFlags> stageFlags; // stageFlags per descriptor in this layout to verify correct updates
Chia-I Wud46e6ae2015-10-31 00:31:16 +0800243 unordered_set<uint32_t> bindings;
Mark Lobodzinski2bf36f02015-11-17 12:42:57 -0700244 // Default constructor
Mark Lobodzinskic44baa52015-12-11 11:56:07 -0700245 _LAYOUT_NODE():layout{},
246 createInfo{},
247 startIndex(0),
248 endIndex(0),
249 dynamicDescriptorCount(0)
250 {};
Tobin Ehlis7265e832015-01-19 08:42:29 -0700251} LAYOUT_NODE;
Mark Lobodzinski2bf36f02015-11-17 12:42:57 -0700252
Tobin Ehlis644ff042015-10-20 10:11:55 -0600253// Store layouts and pushconstants for PipelineLayout
254struct PIPELINE_LAYOUT_NODE {
255 vector<VkDescriptorSetLayout> descriptorSetLayouts;
256 vector<VkPushConstantRange> pushConstantRanges;
257};
258
Tobin Ehlis7265e832015-01-19 08:42:29 -0700259typedef struct _SET_NODE {
Tobin Ehlisce132d82015-06-19 15:07:05 -0600260 VkDescriptorSet set;
261 VkDescriptorPool pool;
Tobin Ehlis481ec712015-02-19 09:55:18 -0700262 // Head of LL of all Update structs for this set
Tobin Ehlisce132d82015-06-19 15:07:05 -0600263 GENERIC_HEADER* pUpdateStructs;
Tobin Ehlis04178d72015-01-22 10:45:21 -0700264 // Total num of descriptors in this set (count of its layout plus all prior layouts)
Tobin Ehlisce132d82015-06-19 15:07:05 -0600265 uint32_t descriptorCount;
266 GENERIC_HEADER** ppDescriptors; // Array where each index points to update node for its slot
267 LAYOUT_NODE* pLayout; // Layout for this set
268 struct _SET_NODE* pNext;
Tobin Ehlis7265e832015-01-19 08:42:29 -0700269} SET_NODE;
270
Mark Lobodzinski39298632015-11-18 08:38:27 -0700271typedef struct _DESCRIPTOR_POOL_NODE {
Tobin Ehlisce132d82015-06-19 15:07:05 -0600272 VkDescriptorPool pool;
Courtney Goeltzenleuchterbee18a92015-10-23 14:21:05 -0600273 uint32_t maxSets;
Tobin Ehlisce132d82015-06-19 15:07:05 -0600274 VkDescriptorPoolCreateInfo createInfo;
275 SET_NODE* pSets; // Head of LL of sets for this Pool
Tobin Ehlisf93f1e32015-10-20 16:16:04 -0600276 vector<uint32_t> maxDescriptorTypeCount; // max # of descriptors of each type in this pool
277 vector<uint32_t> availableDescriptorTypeCount; // available # of descriptors of each type in this pool
278
Mark Lobodzinski39298632015-11-18 08:38:27 -0700279 _DESCRIPTOR_POOL_NODE(const VkDescriptorPool pool, const VkDescriptorPoolCreateInfo* pCreateInfo) :
Courtney Goeltzenleuchterbee18a92015-10-23 14:21:05 -0600280 pool(pool), createInfo(*pCreateInfo), maxSets(pCreateInfo->maxSets), pSets(NULL),
Tobin Ehlisf93f1e32015-10-20 16:16:04 -0600281 maxDescriptorTypeCount(VK_DESCRIPTOR_TYPE_END_RANGE), availableDescriptorTypeCount(VK_DESCRIPTOR_TYPE_END_RANGE)
282 {
Chia-I Wu1b99bb22015-10-27 19:25:11 +0800283 if (createInfo.poolSizeCount) { // Shadow type struct from ptr into local struct
284 size_t poolSizeCountSize = createInfo.poolSizeCount * sizeof(VkDescriptorPoolSize);
285 createInfo.pPoolSizes = new VkDescriptorPoolSize[poolSizeCountSize];
286 memcpy((void*)createInfo.pPoolSizes, pCreateInfo->pPoolSizes, poolSizeCountSize);
Tobin Ehlisf93f1e32015-10-20 16:16:04 -0600287 // Now set max counts for each descriptor type based on count of that type times maxSets
Courtney Goeltzenleuchter6ed5dc22015-11-03 15:41:43 -0700288 uint32_t i=0;
Chia-I Wu1b99bb22015-10-27 19:25:11 +0800289 for (i=0; i<createInfo.poolSizeCount; ++i) {
290 uint32_t typeIndex = static_cast<uint32_t>(createInfo.pPoolSizes[i].type);
291 uint32_t poolSizeCount = createInfo.pPoolSizes[i].descriptorCount;
292 maxDescriptorTypeCount[typeIndex] += poolSizeCount;
Tobin Ehlisf93f1e32015-10-20 16:16:04 -0600293 }
294 for (i=0; i<maxDescriptorTypeCount.size(); ++i) {
295 maxDescriptorTypeCount[i] *= createInfo.maxSets;
296 // Initially the available counts are equal to the max counts
297 availableDescriptorTypeCount[i] = maxDescriptorTypeCount[i];
298 }
299 } else {
Chia-I Wu1b99bb22015-10-27 19:25:11 +0800300 createInfo.pPoolSizes = NULL; // Make sure this is NULL so we don't try to clean it up
Tobin Ehlisf93f1e32015-10-20 16:16:04 -0600301 }
302 }
Mark Lobodzinski39298632015-11-18 08:38:27 -0700303 ~_DESCRIPTOR_POOL_NODE() {
Chia-I Wu1b99bb22015-10-27 19:25:11 +0800304 if (createInfo.pPoolSizes) {
305 delete[] createInfo.pPoolSizes;
Tobin Ehlisf93f1e32015-10-20 16:16:04 -0600306 }
307 // TODO : pSets are currently freed in deletePools function which uses freeShadowUpdateTree function
308 // need to migrate that struct to smart ptrs for auto-cleanup
309 }
Mark Lobodzinski39298632015-11-18 08:38:27 -0700310} DESCRIPTOR_POOL_NODE;
Tobin Ehlis7265e832015-01-19 08:42:29 -0700311
Tobin Ehlisd01f7d62015-02-13 10:26:14 -0700312// Cmd Buffer Tracking
313typedef enum _CMD_TYPE
314{
315 CMD_BINDPIPELINE,
316 CMD_BINDPIPELINEDELTA,
Courtney Goeltzenleuchter49c73082015-09-17 15:06:17 -0600317 CMD_SETVIEWPORTSTATE,
Courtney Goeltzenleuchter078f8172015-09-21 11:44:06 -0600318 CMD_SETSCISSORSTATE,
Courtney Goeltzenleuchter49c73082015-09-17 15:06:17 -0600319 CMD_SETLINEWIDTHSTATE,
320 CMD_SETDEPTHBIASSTATE,
321 CMD_SETBLENDSTATE,
322 CMD_SETDEPTHBOUNDSSTATE,
323 CMD_SETSTENCILREADMASKSTATE,
324 CMD_SETSTENCILWRITEMASKSTATE,
325 CMD_SETSTENCILREFERENCESTATE,
Tobin Ehlis793ad302015-04-03 12:01:11 -0600326 CMD_BINDDESCRIPTORSETS,
Tobin Ehlisd01f7d62015-02-13 10:26:14 -0700327 CMD_BINDINDEXBUFFER,
328 CMD_BINDVERTEXBUFFER,
329 CMD_DRAW,
330 CMD_DRAWINDEXED,
331 CMD_DRAWINDIRECT,
332 CMD_DRAWINDEXEDINDIRECT,
333 CMD_DISPATCH,
334 CMD_DISPATCHINDIRECT,
335 CMD_COPYBUFFER,
336 CMD_COPYIMAGE,
Tobin Ehlis793ad302015-04-03 12:01:11 -0600337 CMD_BLITIMAGE,
Tobin Ehlisd01f7d62015-02-13 10:26:14 -0700338 CMD_COPYBUFFERTOIMAGE,
339 CMD_COPYIMAGETOBUFFER,
340 CMD_CLONEIMAGEDATA,
341 CMD_UPDATEBUFFER,
342 CMD_FILLBUFFER,
343 CMD_CLEARCOLORIMAGE,
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600344 CMD_CLEARATTACHMENTS,
Tobin Ehlis53eddda2015-07-01 16:46:13 -0600345 CMD_CLEARDEPTHSTENCILIMAGE,
Tobin Ehlisd01f7d62015-02-13 10:26:14 -0700346 CMD_RESOLVEIMAGE,
347 CMD_SETEVENT,
348 CMD_RESETEVENT,
349 CMD_WAITEVENTS,
350 CMD_PIPELINEBARRIER,
351 CMD_BEGINQUERY,
352 CMD_ENDQUERY,
353 CMD_RESETQUERYPOOL,
Mark Lobodzinski5495d132015-09-30 16:19:16 -0600354 CMD_COPYQUERYPOOLRESULTS,
Tobin Ehlisd01f7d62015-02-13 10:26:14 -0700355 CMD_WRITETIMESTAMP,
356 CMD_INITATOMICCOUNTERS,
357 CMD_LOADATOMICCOUNTERS,
358 CMD_SAVEATOMICCOUNTERS,
359 CMD_BEGINRENDERPASS,
Chia-I Wu08accc62015-07-07 11:50:03 +0800360 CMD_NEXTSUBPASS,
Tobin Ehlis67449422015-03-02 10:16:40 -0700361 CMD_ENDRENDERPASS,
Chia-I Wu0b50a1c2015-06-26 15:34:39 +0800362 CMD_EXECUTECOMMANDS,
Tobin Ehlis67449422015-03-02 10:16:40 -0700363 CMD_DBGMARKERBEGIN,
364 CMD_DBGMARKEREND,
Tobin Ehlisd01f7d62015-02-13 10:26:14 -0700365} CMD_TYPE;
366// Data structure for holding sequence of cmds in cmd buffer
367typedef struct _CMD_NODE {
Tobin Ehlisd01f7d62015-02-13 10:26:14 -0700368 CMD_TYPE type;
369 uint64_t cmdNumber;
370} CMD_NODE;
371
372typedef enum _CB_STATE
373{
Tobin Ehlisac0ef842015-12-14 13:46:38 -0700374 CB_NEW, // Newly created CB w/o any cmds
375 CB_RECORDING, // BeginCB has been called on this CB
376 CB_RECORDED // EndCB has been called on this CB
Tobin Ehlisd01f7d62015-02-13 10:26:14 -0700377} CB_STATE;
Tobin Ehlise382c5a2015-06-10 12:57:07 -0600378// CB Status -- used to track status of various bindings on cmd buffer objects
379typedef VkFlags CBStatusFlags;
380typedef enum _CBStatusFlagBits
381{
382 CBSTATUS_NONE = 0x00000000, // No status is set
Courtney Goeltzenleuchter49c73082015-09-17 15:06:17 -0600383 CBSTATUS_VIEWPORT_SET = 0x00000001, // Viewport has been set
384 CBSTATUS_LINE_WIDTH_SET = 0x00000002, // Line width has been set
385 CBSTATUS_DEPTH_BIAS_SET = 0x00000004, // Depth bias has been set
386 CBSTATUS_COLOR_BLEND_WRITE_ENABLE = 0x00000008, // PSO w/ CB Enable set has been set
387 CBSTATUS_BLEND_SET = 0x00000010, // Blend state object has been set
388 CBSTATUS_DEPTH_WRITE_ENABLE = 0x00000020, // PSO w/ Depth Enable set has been set
389 CBSTATUS_STENCIL_TEST_ENABLE = 0x00000040, // PSO w/ Stencil Enable set has been set
390 CBSTATUS_DEPTH_BOUNDS_SET = 0x00000080, // Depth bounds state object has been set
391 CBSTATUS_STENCIL_READ_MASK_SET = 0x00000100, // Stencil read mask has been set
392 CBSTATUS_STENCIL_WRITE_MASK_SET = 0x00000200, // Stencil write mask has been set
393 CBSTATUS_STENCIL_REFERENCE_SET = 0x00000400, // Stencil reference has been set
394 CBSTATUS_INDEX_BUFFER_BOUND = 0x00000800, // Index buffer has been set
Courtney Goeltzenleuchter078f8172015-09-21 11:44:06 -0600395 CBSTATUS_SCISSOR_SET = 0x00001000, // Scissor has been set
Tobin Ehlis5e5a1e92015-10-01 09:24:40 -0600396 CBSTATUS_ALL = 0x00001FFF, // All dynamic state set
Tobin Ehlise382c5a2015-06-10 12:57:07 -0600397} CBStatusFlagBits;
Tobin Ehlis60a9b4f2015-07-07 10:42:20 -0600398
Courtney Goeltzenleuchter49c73082015-09-17 15:06:17 -0600399typedef struct stencil_data {
Chia-I Wu1b99bb22015-10-27 19:25:11 +0800400 uint32_t compareMask;
401 uint32_t writeMask;
402 uint32_t reference;
Courtney Goeltzenleuchter49c73082015-09-17 15:06:17 -0600403} CBStencilData;
404
Tobin Ehlis10ae8c12015-03-17 16:24:32 -0600405// Cmd Buffer Wrapper Struct
Tobin Ehlisd01f7d62015-02-13 10:26:14 -0700406typedef struct _GLOBAL_CB_NODE {
Michael Lentineabc5e922015-10-12 11:30:14 -0500407 VkCommandBuffer commandBuffer;
408 VkCommandBufferAllocateInfo createInfo;
409 VkCommandBufferBeginInfo beginInfo;
Tobin Ehlisa9f3d762015-05-22 12:38:16 -0600410 VkFence fence; // fence tracking this cmd buffer
411 uint64_t numCmds; // number of cmds in this CB
412 uint64_t drawCount[NUM_DRAW_TYPES]; // Count of each type of draw in this CB
Tobin Ehlise382c5a2015-06-10 12:57:07 -0600413 CB_STATE state; // Track cmd buffer update state
Tobin Ehlis59278bf2015-08-18 07:10:58 -0600414 uint64_t submitCount; // Number of times CB has been submitted
Tobin Ehlise382c5a2015-06-10 12:57:07 -0600415 CBStatusFlags status; // Track status of various bindings on cmd buffer
Tobin Ehlisa9f3d762015-05-22 12:38:16 -0600416 vector<CMD_NODE*> pCmds;
Tobin Ehlisd01f7d62015-02-13 10:26:14 -0700417 // Currently storing "lastBound" objects on per-CB basis
418 // long-term may want to create caches of "lastBound" states and could have
419 // each individual CMD_NODE referencing its own "lastBound" state
Tobin Ehlisa9f3d762015-05-22 12:38:16 -0600420 VkPipeline lastBoundPipeline;
421 uint32_t lastVtxBinding;
Mark Lobodzinskidfcd9b62015-12-14 15:14:10 -0700422 vector<VkBuffer> boundVtxBuffers;
Courtney Goeltzenleuchter49c73082015-09-17 15:06:17 -0600423 vector<VkViewport> viewports;
424 vector<VkRect2D> scissors;
425 float lineWidth;
Chia-I Wud8c946a2015-10-26 19:08:09 +0800426 float depthBiasConstantFactor;
Courtney Goeltzenleuchter49c73082015-09-17 15:06:17 -0600427 float depthBiasClamp;
Chia-I Wud8c946a2015-10-26 19:08:09 +0800428 float depthBiasSlopeFactor;
Chia-I Wu2bfb33c2015-10-26 17:24:52 +0800429 float blendConstants[4];
Courtney Goeltzenleuchter49c73082015-09-17 15:06:17 -0600430 float minDepthBounds;
431 float maxDepthBounds;
432 CBStencilData front;
433 CBStencilData back;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600434 VkDescriptorSet lastBoundDescriptorSet;
Tobin Ehlis429b91d2015-06-22 17:20:50 -0600435 VkPipelineLayout lastBoundPipelineLayout;
Michael Lentineabc5e922015-10-12 11:30:14 -0500436 VkRenderPassBeginInfo activeRenderPassBeginInfo;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600437 VkRenderPass activeRenderPass;
Chia-I Wu08accc62015-07-07 11:50:03 +0800438 uint32_t activeSubpass;
Tobin Ehlisa9f3d762015-05-22 12:38:16 -0600439 VkFramebuffer framebuffer;
Tobin Ehlis559c6382015-11-05 09:52:49 -0700440 vector<VkDescriptorSet> boundDescriptorSets; // Index is set# that given set is bound to
Michael Lentineabc5e922015-10-12 11:30:14 -0500441 unordered_map<VkImage, IMAGE_CMD_BUF_NODE> imageLayoutMap;
Tobin Ehlisd01f7d62015-02-13 10:26:14 -0700442} GLOBAL_CB_NODE;
Michael Lentineabc5e922015-10-12 11:30:14 -0500443
444typedef struct _SWAPCHAIN_NODE {
445 std::vector<VkImage> images;
446} SWAPCHAIN_NODE;