blob: 6df743d1002405f3ce9e0d8d617e8282b1009b0e [file] [log] [blame]
Tobin Ehlise79df942014-11-18 16:38:08 -07001/*
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -06002 * Vulkan
Tobin Ehlise79df942014-11-18 16:38:08 -07003 *
4 * Copyright (C) 2014 LunarG, Inc.
5 *
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.
23 */
Tobin Ehlis2d1d9702015-07-03 09:42:57 -060024#include "vk_layer.h"
Tobin Ehlis63bb9482015-03-17 16:24:32 -060025#include <vector>
26
27using namespace std;
28
Tobin Ehlise79df942014-11-18 16:38:08 -070029// Draw State ERROR codes
30typedef enum _DRAW_STATE_ERROR
31{
Tobin Ehlis84c521c2015-01-19 08:42:29 -070032 DRAWSTATE_NONE, // Used for INFO & other non-error messages
Tobin Ehlis41415bb2015-01-22 10:45:21 -070033 DRAWSTATE_INTERNAL_ERROR, // Error with DrawState internal data structures
Tobin Ehlis84c521c2015-01-19 08:42:29 -070034 DRAWSTATE_NO_PIPELINE_BOUND, // Unable to identify a bound pipeline
Tobin Ehlisdd82f6b2015-04-03 12:01:11 -060035 DRAWSTATE_INVALID_POOL, // Invalid DS pool
Tobin Ehlis83ebbef2015-02-10 15:35:23 -070036 DRAWSTATE_INVALID_SET, // Invalid DS
Tobin Ehlis41415bb2015-01-22 10:45:21 -070037 DRAWSTATE_INVALID_LAYOUT, // Invalid DS layout
Tobin Ehlisde63c532015-06-18 15:59:33 -060038 DRAWSTATE_INVALID_PIPELINE, // Invalid Pipeline handle referenced
39 DRAWSTATE_INVALID_PIPELINE_CREATE_STATE, // Attempt to create a pipeline with invalid state
Tobin Ehlis8cced212015-02-13 10:26:14 -070040 DRAWSTATE_INVALID_CMD_BUFFER, // Invalid CmdBuffer referenced
Courtney Goeltzenleuchter9cc421e2015-04-08 15:36:08 -060041 DRAWSTATE_VTX_INDEX_OUT_OF_BOUNDS, // binding in vkCmdBindVertexData() too large for PSO's pVertexBindingDescriptions array
Tobin Ehlis84c521c2015-01-19 08:42:29 -070042 DRAWSTATE_INVALID_DYNAMIC_STATE_OBJECT, // Invalid dyn state object
43 DRAWSTATE_MISSING_DOT_PROGRAM, // No "dot" program in order to generate png image
Tobin Ehlis41415bb2015-01-22 10:45:21 -070044 DRAWSTATE_OUT_OF_MEMORY, // malloc failed
45 DRAWSTATE_DESCRIPTOR_TYPE_MISMATCH, // Type in layout vs. update are not the same
Tobin Ehlis83ebbef2015-02-10 15:35:23 -070046 DRAWSTATE_DESCRIPTOR_UPDATE_OUT_OF_BOUNDS, // Descriptors set for update out of bounds for corresponding layout section
Tobin Ehlis8733adc2015-02-23 16:09:58 -070047 DRAWSTATE_INVALID_UPDATE_INDEX, // Index of requested update is invalid for specified descriptors set
Tobin Ehlis2464b882015-04-01 08:40:34 -060048 DRAWSTATE_INVALID_UPDATE_STRUCT, // Struct in DS Update tree is of invalid type
Tobin Ehlis28be0be2015-05-22 12:38:16 -060049 DRAWSTATE_NUM_SAMPLES_MISMATCH, // Number of samples in bound PSO does not match number in FB of current RenderPass
50 DRAWSTATE_NO_END_CMD_BUFFER, // Must call vkEndCommandBuffer() before QueueSubmit on that cmdBuffer
Tobin Ehlise42007c2015-06-19 13:00:59 -060051 DRAWSTATE_NO_BEGIN_CMD_BUFFER, // Binding cmds or calling End on CB that never had vkBeginCommandBuffer() called on it
Tobin Ehlis97866202015-06-10 12:57:07 -060052 DRAWSTATE_VIEWPORT_NOT_BOUND, // Draw submitted with no viewport state object bound
53 DRAWSTATE_RASTER_NOT_BOUND, // Draw submitted with no raster state object bound
54 DRAWSTATE_COLOR_BLEND_NOT_BOUND, // Draw submitted with no color blend state object bound when color write enabled
55 DRAWSTATE_DEPTH_STENCIL_NOT_BOUND, // Draw submitted with no depth-stencil state object bound when depth write enabled
Tobin Ehlisa366ca22015-06-19 15:07:05 -060056 DRAWSTATE_INDEX_BUFFER_NOT_BOUND, // Draw submitted with no depth-stencil state object bound when depth write enabled
Tobin Ehlisc6c3d6d2015-06-22 17:20:50 -060057 DRAWSTATE_PIPELINE_LAYOUT_MISMATCH, // Draw submitted PSO Pipeline layout that doesn't match layout from BindDescriptorSets
Tobin Ehlis8b6c2352015-06-23 16:13:03 -060058 DRAWSTATE_INVALID_RENDERPASS, // Use of a NULL or otherwise invalid RenderPass object
Tobin Ehlis451efca2015-06-23 11:22:55 -060059 DRAWSTATE_INVALID_RENDERPASS_CMD, // Invalid cmd submitted while a RenderPass is active
60 DRAWSTATE_NO_ACTIVE_RENDERPASS, // Rendering cmd submitted without an active RenderPass
Tobin Ehlise4076782015-06-24 15:53:07 -060061 DRAWSTATE_DESCRIPTOR_SET_NOT_UPDATED, // DescriptorSet bound but it was never updated. This is a warning code.
Tobin Ehlis8cd650e2015-07-01 16:46:13 -060062 DRAWSTATE_CLEAR_CMD_BEFORE_DRAW, // Clear cmd issued before any Draw in CmdBuffer, should use RenderPass Ops instead
Tobin Ehlisde63c532015-06-18 15:59:33 -060063 DRAWSTATE_INVALID_EXTENSION,
Tobin Ehlise79df942014-11-18 16:38:08 -070064} DRAW_STATE_ERROR;
Tobin Ehlis26092022014-11-20 09:49:17 -070065
66typedef enum _DRAW_TYPE
67{
68 DRAW = 0,
69 DRAW_INDEXED = 1,
70 DRAW_INDIRECT = 2,
71 DRAW_INDEXED_INDIRECT = 3,
72 DRAW_BEGIN_RANGE = DRAW,
73 DRAW_END_RANGE = DRAW_INDEXED_INDIRECT,
74 NUM_DRAW_TYPES = (DRAW_END_RANGE - DRAW_BEGIN_RANGE + 1),
75} DRAW_TYPE;
Tobin Ehlisa701ef02014-11-27 15:43:39 -070076
Tobin Ehlis84c521c2015-01-19 08:42:29 -070077typedef struct _SHADER_DS_MAPPING {
78 uint32_t slotCount;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -060079 VkDescriptorSetLayoutCreateInfo* pShaderMappingSlot;
Tobin Ehlis84c521c2015-01-19 08:42:29 -070080} SHADER_DS_MAPPING;
81
Tobin Ehlis41415bb2015-01-22 10:45:21 -070082typedef struct _GENERIC_HEADER {
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -060083 VkStructureType sType;
Tobin Ehlis84c521c2015-01-19 08:42:29 -070084 const void* pNext;
Tobin Ehlis41415bb2015-01-22 10:45:21 -070085} GENERIC_HEADER;
Tobin Ehlis84c521c2015-01-19 08:42:29 -070086
87typedef struct _PIPELINE_NODE {
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -060088 VkPipeline pipeline;
89 VkGraphicsPipelineCreateInfo graphicsPipelineCI;
90 VkPipelineVertexInputStateCreateInfo vertexInputCI;
91 VkPipelineIaStateCreateInfo iaStateCI;
92 VkPipelineTessStateCreateInfo tessStateCI;
93 VkPipelineVpStateCreateInfo vpStateCI;
94 VkPipelineRsStateCreateInfo rsStateCI;
95 VkPipelineMsStateCreateInfo msStateCI;
96 VkPipelineCbStateCreateInfo cbStateCI;
97 VkPipelineDsStateCreateInfo dsStateCI;
98 VkPipelineShaderStageCreateInfo vsCI;
99 VkPipelineShaderStageCreateInfo tcsCI;
100 VkPipelineShaderStageCreateInfo tesCI;
101 VkPipelineShaderStageCreateInfo gsCI;
102 VkPipelineShaderStageCreateInfo fsCI;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600103 // Compute shader is include in VkComputePipelineCreateInfo
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -0600104 VkComputePipelineCreateInfo computePipelineCI;
Tobin Ehlis806a97a2015-06-18 11:02:59 -0600105 // Flag of which shader stages are active for this pipeline
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -0600106 uint32_t active_shaders;
107 VkGraphicsPipelineCreateInfo* pCreateTree; // Ptr to shadow of data in create tree
Tobin Ehlis84c521c2015-01-19 08:42:29 -0700108 // Vtx input info (if any)
Mark Lobodzinski0e0fb5c2015-06-23 15:11:57 -0600109 uint32_t vtxBindingCount; // number of bindings
110 VkVertexInputBindingDescription* pVertexBindingDescriptions;
111 uint32_t vtxAttributeCount; // number of attributes
112 VkVertexInputAttributeDescription* pVertexAttributeDescriptions;
113 uint32_t attachmentCount; // number of CB attachments
114 VkPipelineCbAttachmentState* pAttachments;
Tobin Ehlis84c521c2015-01-19 08:42:29 -0700115} PIPELINE_NODE;
116
117typedef struct _SAMPLER_NODE {
Tobin Ehlisa366ca22015-06-19 15:07:05 -0600118 VkSampler sampler;
119 VkSamplerCreateInfo createInfo;
Tobin Ehlis84c521c2015-01-19 08:42:29 -0700120} SAMPLER_NODE;
121
Tobin Ehlis41415bb2015-01-22 10:45:21 -0700122typedef struct _IMAGE_NODE {
Tobin Ehlis8cd650e2015-07-01 16:46:13 -0600123 union {
124 VkImageViewCreateInfo ivci;
125 VkColorAttachmentViewCreateInfo cvci;
126 VkDepthStencilViewCreateInfo dsvci;
127 } createInfo;
Tobin Ehlis41415bb2015-01-22 10:45:21 -0700128} IMAGE_NODE;
129
130typedef struct _BUFFER_NODE {
Tobin Ehlisa366ca22015-06-19 15:07:05 -0600131 VkBufferView buffer;
Courtney Goeltzenleuchterddcb6192015-04-14 18:48:46 -0600132 VkBufferViewCreateInfo createInfo;
Tobin Ehlisa366ca22015-06-19 15:07:05 -0600133 VkDescriptorInfo descriptorInfo;
Tobin Ehlis41415bb2015-01-22 10:45:21 -0700134} BUFFER_NODE;
135
Tobin Ehlis84c521c2015-01-19 08:42:29 -0700136typedef struct _DYNAMIC_STATE_NODE {
Tobin Ehlisa366ca22015-06-19 15:07:05 -0600137 VkObjectType objType;
138 VkDynamicStateObject stateObj;
139 GENERIC_HEADER* pCreateInfo;
Tobin Ehlis63bb9482015-03-17 16:24:32 -0600140 union {
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600141 VkDynamicVpStateCreateInfo vpci;
142 VkDynamicRsStateCreateInfo rsci;
143 VkDynamicCbStateCreateInfo cbci;
144 VkDynamicDsStateCreateInfo dsci;
Tobin Ehlis63bb9482015-03-17 16:24:32 -0600145 } create_info;
Tobin Ehlis84c521c2015-01-19 08:42:29 -0700146} DYNAMIC_STATE_NODE;
Tobin Ehlis84c521c2015-01-19 08:42:29 -0700147// Descriptor Data structures
Tobin Ehlis41415bb2015-01-22 10:45:21 -0700148// Layout Node has the core layout data
Tobin Ehlis84c521c2015-01-19 08:42:29 -0700149typedef struct _LAYOUT_NODE {
Tobin Ehlisa366ca22015-06-19 15:07:05 -0600150 VkDescriptorSetLayout layout;
151 VkDescriptorType* pTypes; // Dynamic array that will be created to verify descriptor types
152 VkDescriptorSetLayoutCreateInfo createInfo;
153 uint32_t startIndex; // 1st index of this layout
154 uint32_t endIndex; // last index of this layout
Tobin Ehlis84c521c2015-01-19 08:42:29 -0700155} LAYOUT_NODE;
Tobin Ehlis84c521c2015-01-19 08:42:29 -0700156typedef struct _SET_NODE {
Tobin Ehlisa366ca22015-06-19 15:07:05 -0600157 VkDescriptorSet set;
158 VkDescriptorPool pool;
159 VkDescriptorSetUsage setUsage;
Tobin Ehlis82871a82015-02-19 09:55:18 -0700160 // Head of LL of all Update structs for this set
Tobin Ehlisa366ca22015-06-19 15:07:05 -0600161 GENERIC_HEADER* pUpdateStructs;
Tobin Ehlis41415bb2015-01-22 10:45:21 -0700162 // Total num of descriptors in this set (count of its layout plus all prior layouts)
Tobin Ehlisa366ca22015-06-19 15:07:05 -0600163 uint32_t descriptorCount;
164 GENERIC_HEADER** ppDescriptors; // Array where each index points to update node for its slot
165 LAYOUT_NODE* pLayout; // Layout for this set
166 struct _SET_NODE* pNext;
Tobin Ehlis84c521c2015-01-19 08:42:29 -0700167} SET_NODE;
168
Tobin Ehlisdd82f6b2015-04-03 12:01:11 -0600169typedef struct _POOL_NODE {
Tobin Ehlisa366ca22015-06-19 15:07:05 -0600170 VkDescriptorPool pool;
171 VkDescriptorPoolUsage poolUsage;
172 uint32_t maxSets;
173 VkDescriptorPoolCreateInfo createInfo;
174 SET_NODE* pSets; // Head of LL of sets for this Pool
Tobin Ehlisdd82f6b2015-04-03 12:01:11 -0600175} POOL_NODE;
Tobin Ehlis84c521c2015-01-19 08:42:29 -0700176
Tobin Ehlis8cced212015-02-13 10:26:14 -0700177// Cmd Buffer Tracking
178typedef enum _CMD_TYPE
179{
180 CMD_BINDPIPELINE,
181 CMD_BINDPIPELINEDELTA,
182 CMD_BINDDYNAMICSTATEOBJECT,
Tobin Ehlisdd82f6b2015-04-03 12:01:11 -0600183 CMD_BINDDESCRIPTORSETS,
Tobin Ehlis8cced212015-02-13 10:26:14 -0700184 CMD_BINDINDEXBUFFER,
185 CMD_BINDVERTEXBUFFER,
186 CMD_DRAW,
187 CMD_DRAWINDEXED,
188 CMD_DRAWINDIRECT,
189 CMD_DRAWINDEXEDINDIRECT,
190 CMD_DISPATCH,
191 CMD_DISPATCHINDIRECT,
192 CMD_COPYBUFFER,
193 CMD_COPYIMAGE,
Tobin Ehlisdd82f6b2015-04-03 12:01:11 -0600194 CMD_BLITIMAGE,
Tobin Ehlis8cced212015-02-13 10:26:14 -0700195 CMD_COPYBUFFERTOIMAGE,
196 CMD_COPYIMAGETOBUFFER,
197 CMD_CLONEIMAGEDATA,
198 CMD_UPDATEBUFFER,
199 CMD_FILLBUFFER,
200 CMD_CLEARCOLORIMAGE,
Tobin Ehlis8cd650e2015-07-01 16:46:13 -0600201 CMD_CLEARCOLORATTACHMENT,
202 CMD_CLEARDEPTHSTENCILIMAGE,
203 CMD_CLEARDEPTHSTENCILATTACHMENT,
Tobin Ehlis8cced212015-02-13 10:26:14 -0700204 CMD_RESOLVEIMAGE,
205 CMD_SETEVENT,
206 CMD_RESETEVENT,
207 CMD_WAITEVENTS,
208 CMD_PIPELINEBARRIER,
209 CMD_BEGINQUERY,
210 CMD_ENDQUERY,
211 CMD_RESETQUERYPOOL,
212 CMD_WRITETIMESTAMP,
213 CMD_INITATOMICCOUNTERS,
214 CMD_LOADATOMICCOUNTERS,
215 CMD_SAVEATOMICCOUNTERS,
216 CMD_BEGINRENDERPASS,
Tobin Ehlis1dae99a2015-03-02 10:16:40 -0700217 CMD_ENDRENDERPASS,
Chia-I Wu88eaa3b2015-06-26 15:34:39 +0800218 CMD_EXECUTECOMMANDS,
Tobin Ehlis1dae99a2015-03-02 10:16:40 -0700219 CMD_DBGMARKERBEGIN,
220 CMD_DBGMARKEREND,
Tobin Ehlis8cced212015-02-13 10:26:14 -0700221} CMD_TYPE;
222// Data structure for holding sequence of cmds in cmd buffer
223typedef struct _CMD_NODE {
Tobin Ehlis8cced212015-02-13 10:26:14 -0700224 CMD_TYPE type;
225 uint64_t cmdNumber;
226} CMD_NODE;
227
228typedef enum _CB_STATE
229{
230 CB_NEW, // Newly created CB w/o any cmds
231 CB_UPDATE_ACTIVE, // BeginCB has been called on this CB
232 CB_UPDATE_COMPLETE // EndCB has been called on this CB
233} CB_STATE;
Tobin Ehlis97866202015-06-10 12:57:07 -0600234// CB Status -- used to track status of various bindings on cmd buffer objects
235typedef VkFlags CBStatusFlags;
236typedef enum _CBStatusFlagBits
237{
238 CBSTATUS_NONE = 0x00000000, // No status is set
239 CBSTATUS_VIEWPORT_BOUND = 0x00000001, // Viewport state object has been bound
240 CBSTATUS_RASTER_BOUND = 0x00000002, // Raster state object has been bound
241 CBSTATUS_COLOR_BLEND_WRITE_ENABLE = 0x00000004, // PSO w/ CB Enable set has been bound
242 CBSTATUS_COLOR_BLEND_BOUND = 0x00000008, // CB state object has been bound
243 CBSTATUS_DEPTH_STENCIL_WRITE_ENABLE = 0x00000010, // PSO w/ DS Enable set has been bound
244 CBSTATUS_DEPTH_STENCIL_BOUND = 0x00000020, // DS state object has been bound
Tobin Ehlisa366ca22015-06-19 15:07:05 -0600245 CBSTATUS_INDEX_BUFFER_BOUND = 0x00000040, // Index buffer has been bound
Tobin Ehlis97866202015-06-10 12:57:07 -0600246} CBStatusFlagBits;
Tobin Ehlis63bb9482015-03-17 16:24:32 -0600247// Cmd Buffer Wrapper Struct
Tobin Ehlis8cced212015-02-13 10:26:14 -0700248typedef struct _GLOBAL_CB_NODE {
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600249 VkCmdBuffer cmdBuffer;
Tobin Ehlis28be0be2015-05-22 12:38:16 -0600250 uint32_t queueNodeIndex;
251 VkFlags flags;
252 VkFence fence; // fence tracking this cmd buffer
253 uint64_t numCmds; // number of cmds in this CB
254 uint64_t drawCount[NUM_DRAW_TYPES]; // Count of each type of draw in this CB
Tobin Ehlis97866202015-06-10 12:57:07 -0600255 CB_STATE state; // Track cmd buffer update state
256 CBStatusFlags status; // Track status of various bindings on cmd buffer
Tobin Ehlis28be0be2015-05-22 12:38:16 -0600257 vector<CMD_NODE*> pCmds;
Tobin Ehlis8cced212015-02-13 10:26:14 -0700258 // Currently storing "lastBound" objects on per-CB basis
259 // long-term may want to create caches of "lastBound" states and could have
260 // each individual CMD_NODE referencing its own "lastBound" state
Tobin Ehlis28be0be2015-05-22 12:38:16 -0600261 VkPipeline lastBoundPipeline;
262 uint32_t lastVtxBinding;
263 DYNAMIC_STATE_NODE* lastBoundDynamicState[VK_NUM_STATE_BIND_POINT];
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600264 VkDescriptorSet lastBoundDescriptorSet;
Tobin Ehlisc6c3d6d2015-06-22 17:20:50 -0600265 VkPipelineLayout lastBoundPipelineLayout;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600266 VkRenderPass activeRenderPass;
Tobin Ehlis28be0be2015-05-22 12:38:16 -0600267 VkFramebuffer framebuffer;
268 vector<VkDescriptorSet> boundDescriptorSets;
Tobin Ehlis8cced212015-02-13 10:26:14 -0700269} GLOBAL_CB_NODE;
270
Tobin Ehlisa701ef02014-11-27 15:43:39 -0700271//prototypes for extension functions
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -0600272void drawStateDumpDotFile(char* outFileName);
Tobin Ehlisde63c532015-06-18 15:59:33 -0600273void drawStateDumpPngFile(const VkDevice device, char* outFileName);
Jeremy Hayes7ec63022015-02-26 15:59:19 -0700274void drawStateDumpCommandBufferDotFile(char* outFileName);
Tobin Ehlis266473d2014-12-16 17:34:50 -0700275// Func ptr typedefs
Mark Lobodzinskie2d07a52015-01-29 08:55:56 -0600276typedef void (*DRAW_STATE_DUMP_DOT_FILE)(char*);
277typedef void (*DRAW_STATE_DUMP_PNG_FILE)(char*);
Jeremy Hayes7ec63022015-02-26 15:59:19 -0700278typedef void (*DRAW_STATE_DUMP_COMMAND_BUFFER_DOT_FILE)(char*);