source/backends/vulkan/pipelinestate_backend.cpp

   1 #include <msp/core/hash.h>
   2 #include "batch.h"
   3 #include "blend.h"
   4 #include "buffer.h"
   5 #include "depthtest.h"
   6 #include "device.h"
   7 #include "framebuffer.h"
   8 #include "pipelinestate.h"
   9 #include "pipelinestate_backend.h"
  10 #include "program.h"
  11 #include "rect.h"
  12 #include "sampler.h"
  13 #include "stenciltest.h"
  14 #include "structurebuilder.h"
  15 #include "texture.h"
  16 #include "uniformblock.h"
  17 #include "vertexsetup.h"
  18 #include "vulkan.h"
  19
  20 using namespace std;
  21
  22 namespace Msp {
  23 namespace GL {
  24
  25 VulkanPipelineState::VulkanPipelineState():
  26         device(Device::get_current())
  27 { }
  28
  29 VulkanPipelineState::VulkanPipelineState(VulkanPipelineState &&other):
  30         device(other.device),
  31         handle(other.handle)
  32 { }
  33
  34 void VulkanPipelineState::update() const
  35 {
  36         const PipelineState &self = *static_cast<const PipelineState *>(this);
  37
  38         if(changes&PipelineState::VERTEX_SETUP)
  39                 self.vertex_setup->refresh();
  40
  41         constexpr unsigned pipeline_mask = PipelineState::SHPROG|PipelineState::VERTEX_SETUP|PipelineState::FACE_CULL|
  42                 PipelineState::DEPTH_TEST|PipelineState::STENCIL_TEST|PipelineState::BLEND|PipelineState::PRIMITIVE_TYPE;
  43         if(changes&pipeline_mask)
  44                 handle = device.get_pipeline_cache().get_pipeline(self);
  45
  46         if(changes&(PipelineState::SHPROG|PipelineState::UNIFORMS|PipelineState::TEXTURES))
  47         {
  48                 unsigned changed_sets = (changes&PipelineState::SHPROG ? ~0U : 0U);
  49                 for(const PipelineState::BoundUniformBlock &u: self.uniform_blocks)
  50                         if(u.changed || changed_sets==~0U)
  51                         {
  52                                 if(u.block)
  53                                         u.used = self.shprog->uses_uniform_block_binding(u.binding);
  54                                 if(u.binding>=0)
  55                                         changed_sets |= 1<<(u.binding>>20);
  56                                 u.changed = false;
  57                         }
  58                 for(const PipelineState::BoundTexture &t: self.textures)
  59                         if(t.changed || changed_sets==~0U)
  60                         {
  61                                 if(t.texture && t.sampler)
  62                                         t.used = self.shprog->uses_texture_binding(t.binding);
  63                                 changed_sets |= 1<<(t.binding>>20);
  64                                 if(t.texture && t.level>=0)
  65                                         t.texture->refresh_mip_views();
  66                                 if(t.sampler)
  67                                         t.sampler->refresh();
  68                                 t.changed = false;
  69                         }
  70
  71                 if(changed_sets)
  72                 {
  73                         descriptor_set_handles.resize(self.shprog->get_n_descriptor_sets());
  74                         for(unsigned i=0; i<descriptor_set_handles.size(); ++i)
  75                                 if(changed_sets&(1<<i))
  76                                         descriptor_set_handles[i] = device.get_pipeline_cache().get_descriptor_set(self, i);
  77                 }
  78         }
  79
  80         changes = 0;
  81 }
  82
  83 uint64_t VulkanPipelineState::compute_hash() const
  84 {
  85         const PipelineState &self = *static_cast<const PipelineState *>(this);
  86         const FrameFormat &format = self.framebuffer->get_format();
  87
  88         uint64_t result = hash<64>(self.shprog);
  89         result = hash_update<64>(result, self.vertex_setup->compute_hash());
  90         result = hash_round<64>(result, self.primitive_type);
  91
  92         if(self.front_face!=NON_MANIFOLD && self.face_cull!=NO_CULL)
  93         {
  94                 result = hash_round<64>(result, self.front_face);
  95                 result = hash_round<64>(result, self.face_cull);
  96         }
  97
  98         result = hash_round<64>(result, format.get_samples());
  99
 100         if(self.depth_test.enabled)
 101         {
 102                 result = hash_round<64>(result, self.depth_test.compare);
 103                 result = hash_update<64>(result, self.depth_test.write);
 104         }
 105
 106         if(self.stencil_test.enabled)
 107         {
 108                 result = hash_round<64>(result, self.stencil_test.compare);
 109                 result = hash_round<64>(result, self.stencil_test.stencil_fail_op);
 110                 result = hash_round<64>(result, self.stencil_test.depth_fail_op);
 111                 result = hash_round<64>(result, self.stencil_test.depth_pass_op);
 112                 result = hash_update<64>(result, self.stencil_test.reference);
 113         }
 114
 115         if(self.blend.enabled)
 116         {
 117                 result = hash_round<64>(result, self.blend.equation);
 118                 result = hash_round<64>(result, self.blend.src_factor);
 119                 result = hash_round<64>(result, self.blend.dst_factor);
 120                 result = hash_round<64>(result, self.blend.write_mask);
 121         }
 122
 123         for(FrameAttachment a: format)
 124                 result = hash_update<64>(result, a);
 125
 126         return result;
 127 }
 128
 129 void VulkanPipelineState::fill_creation_info(vector<char> &buffer) const
 130 {
 131         const PipelineState &self = *static_cast<const PipelineState *>(this);
 132
 133         const FrameFormat &format = self.framebuffer->get_format();
 134         VkRenderPass render_pass = device.get_pipeline_cache().get_render_pass(format, false, false, false);
 135
 136         unsigned n_color_attachments = 0;
 137         for(FrameAttachment a: format)
 138         {
 139                 unsigned attach_pt = get_attach_point(a);
 140                 if(attach_pt!=get_attach_point(DEPTH_ATTACHMENT) && attach_pt!=get_attach_point(STENCIL_ATTACHMENT))
 141                         ++n_color_attachments;
 142         }
 143
 144         StructureBuilder sb(buffer, 10);
 145         VkGraphicsPipelineCreateInfo *&pipeline_info = sb.add<VkGraphicsPipelineCreateInfo>();
 146         VkPipelineInputAssemblyStateCreateInfo *&input_assembly_info = sb.add<VkPipelineInputAssemblyStateCreateInfo>();
 147         VkPipelineViewportStateCreateInfo *&viewport_info = sb.add<VkPipelineViewportStateCreateInfo>();
 148         VkPipelineRasterizationStateCreateInfo *&raster_info = sb.add<VkPipelineRasterizationStateCreateInfo>();
 149         VkPipelineMultisampleStateCreateInfo *&multisample_info = sb.add<VkPipelineMultisampleStateCreateInfo>();
 150         VkPipelineDepthStencilStateCreateInfo *&depth_stencil_info = sb.add<VkPipelineDepthStencilStateCreateInfo>();
 151         VkPipelineColorBlendStateCreateInfo *&blend_info = sb.add<VkPipelineColorBlendStateCreateInfo>();
 152         VkPipelineColorBlendAttachmentState *&blend_attachments = sb.add<VkPipelineColorBlendAttachmentState>(n_color_attachments);
 153         VkPipelineDynamicStateCreateInfo *&dynamic_info = sb.add<VkPipelineDynamicStateCreateInfo>();
 154         VkDynamicState *&dynamic_states = sb.add<VkDynamicState>(2);
 155
 156         input_assembly_info->sType = VK_STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO;
 157         input_assembly_info->topology = static_cast<VkPrimitiveTopology>(get_vulkan_primitive_type(self.primitive_type));
 158         input_assembly_info->primitiveRestartEnable = true;
 159
 160         viewport_info->sType = VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO;
 161         viewport_info->viewportCount = 1;
 162         viewport_info->pViewports = 0;
 163         viewport_info->scissorCount = 1;
 164         viewport_info->pScissors = 0;
 165
 166         raster_info->sType = VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO;
 167         raster_info->depthClampEnable = VK_FALSE;
 168         raster_info->rasterizerDiscardEnable = VK_FALSE;
 169         raster_info->polygonMode = VK_POLYGON_MODE_FILL;
 170         if(self.face_cull==NO_CULL || self.front_face==NON_MANIFOLD)
 171         {
 172                 raster_info->cullMode = VK_CULL_MODE_NONE;
 173                 raster_info->frontFace = VK_FRONT_FACE_COUNTER_CLOCKWISE;
 174         }
 175         else
 176         {
 177                 raster_info->cullMode = (self.face_cull==CULL_FRONT ? VK_CULL_MODE_FRONT_BIT : VK_CULL_MODE_BACK_BIT);
 178                 raster_info->frontFace = (self.front_face==CLOCKWISE ? VK_FRONT_FACE_CLOCKWISE : VK_FRONT_FACE_COUNTER_CLOCKWISE);
 179         }
 180         raster_info->depthBiasEnable = VK_FALSE;
 181         raster_info->depthBiasConstantFactor = 0.0f;
 182         raster_info->depthBiasClamp = 0.0f;
 183         raster_info->depthBiasSlopeFactor = 0.0f;
 184         raster_info->lineWidth = 1.0f;
 185
 186         multisample_info->sType = VK_STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO;
 187         multisample_info->rasterizationSamples = static_cast<VkSampleCountFlagBits>(get_vulkan_samples(format.get_samples()));
 188         multisample_info->sampleShadingEnable = VK_FALSE;
 189         multisample_info->minSampleShading = 1.0f;
 190         multisample_info->pSampleMask = 0;
 191         multisample_info->alphaToCoverageEnable = VK_FALSE;
 192         multisample_info->alphaToOneEnable = VK_FALSE;
 193
 194         depth_stencil_info->sType = VK_STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO;
 195         depth_stencil_info->depthTestEnable = self.depth_test.enabled;
 196         depth_stencil_info->depthWriteEnable = self.depth_test.write;
 197         depth_stencil_info->depthCompareOp = static_cast<VkCompareOp>(get_vulkan_predicate(self.depth_test.compare));
 198         depth_stencil_info->depthBoundsTestEnable = VK_FALSE;
 199
 200         depth_stencil_info->stencilTestEnable = self.stencil_test.enabled;
 201         depth_stencil_info->front.failOp = static_cast<VkStencilOp>(get_vulkan_stencil_op(self.stencil_test.stencil_fail_op));
 202         depth_stencil_info->front.passOp = static_cast<VkStencilOp>(get_vulkan_stencil_op(self.stencil_test.depth_pass_op));
 203         depth_stencil_info->front.depthFailOp = static_cast<VkStencilOp>(get_vulkan_stencil_op(self.stencil_test.depth_fail_op));
 204         depth_stencil_info->front.compareOp = static_cast<VkCompareOp>(get_vulkan_predicate(self.stencil_test.compare));
 205         depth_stencil_info->front.compareMask = 0xFFFFFFFFU;
 206         depth_stencil_info->front.writeMask = 0xFFFFFFFFU;
 207         depth_stencil_info->front.reference = self.stencil_test.reference;
 208         depth_stencil_info->back = depth_stencil_info->front;
 209
 210         for(unsigned i=0; i<n_color_attachments; ++i)
 211         {
 212                 blend_attachments[i].blendEnable = self.blend.enabled;
 213                 blend_attachments[i].srcColorBlendFactor = static_cast<VkBlendFactor>(get_vulkan_blend_factor(self.blend.src_factor));
 214                 blend_attachments[i].dstColorBlendFactor = static_cast<VkBlendFactor>(get_vulkan_blend_factor(self.blend.dst_factor));
 215                 blend_attachments[i].colorBlendOp = static_cast<VkBlendOp>(get_vulkan_blend_equation(self.blend.equation));
 216                 blend_attachments[i].srcAlphaBlendFactor = blend_attachments[i].srcColorBlendFactor;
 217                 blend_attachments[i].dstAlphaBlendFactor = blend_attachments[i].dstColorBlendFactor;
 218                 blend_attachments[i].alphaBlendOp = blend_attachments[i].colorBlendOp;
 219                 blend_attachments[i].colorWriteMask = get_vulkan_color_mask(self.blend.write_mask);
 220         }
 221
 222         blend_info->sType = VK_STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO;
 223         blend_info->attachmentCount = n_color_attachments;
 224         blend_info->pAttachments = blend_attachments;
 225
 226         dynamic_states[0] = VK_DYNAMIC_STATE_VIEWPORT;
 227         dynamic_states[1] = VK_DYNAMIC_STATE_SCISSOR;
 228
 229         dynamic_info->sType = VK_STRUCTURE_TYPE_PIPELINE_DYNAMIC_STATE_CREATE_INFO;
 230         dynamic_info->dynamicStateCount = 2;
 231         dynamic_info->pDynamicStates = dynamic_states;
 232
 233         pipeline_info->sType = VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO;
 234
 235         pipeline_info->pInputAssemblyState = input_assembly_info;
 236         pipeline_info->pTessellationState = 0;
 237         pipeline_info->pViewportState = viewport_info;
 238         pipeline_info->pRasterizationState = raster_info;
 239         pipeline_info->pMultisampleState = multisample_info;
 240         pipeline_info->pDepthStencilState = depth_stencil_info;
 241         pipeline_info->pColorBlendState = blend_info;
 242         pipeline_info->pDynamicState = dynamic_info;
 243         pipeline_info->renderPass = handle_cast<::VkRenderPass>(render_pass);
 244         pipeline_info->subpass = 0;
 245
 246         if(self.shprog)
 247         {
 248                 pipeline_info->stageCount = self.shprog->n_stages;
 249                 pipeline_info->pStages = reinterpret_cast<const VkPipelineShaderStageCreateInfo *>(self.shprog->creation_info.data());
 250                 pipeline_info->layout = handle_cast<::VkPipelineLayout>(self.shprog->layout_handle);
 251         }
 252
 253         if(self.vertex_setup)
 254                 pipeline_info->pVertexInputState = reinterpret_cast<const VkPipelineVertexInputStateCreateInfo *>(self.vertex_setup->creation_info.data());
 255 }
 256
 257 uint64_t VulkanPipelineState::compute_descriptor_set_hash(unsigned index) const
 258 {
 259         const PipelineState &self = *static_cast<const PipelineState *>(this);
 260
 261         uint64_t result = hash<64>(0, 0);
 262         for(const PipelineState::BoundUniformBlock &b: self.uniform_blocks)
 263                 if(b.used && b.binding>=0 && static_cast<unsigned>(b.binding>>20)==index)
 264                 {
 265                         result = hash_update<64>(result, b.binding);
 266                         result = hash_update<64>(result, reinterpret_cast<uintptr_t>(b.block));
 267                         result = hash_update<64>(result, reinterpret_cast<uintptr_t>(b.buffer->handle));
 268                 }
 269         for(const PipelineState::BoundTexture &t: self.textures)
 270                 if(t.used && (t.binding>>20)==index)
 271                 {
 272                         result = hash_update<64>(result, t.binding);
 273                         result = hash_update<64>(result, reinterpret_cast<uintptr_t>(t.texture->handle));
 274                         result = hash_update<64>(result, reinterpret_cast<uintptr_t>(t.sampler->handle));
 275                         result = hash_update<64>(result, t.level);
 276                 }
 277
 278         return result;
 279 }
 280
 281 VkDescriptorSetLayout VulkanPipelineState::get_descriptor_set_layout(unsigned index) const
 282 {
 283         return static_cast<const PipelineState *>(this)->shprog->desc_set_layout_handles[index];
 284 }
 285
 286 unsigned VulkanPipelineState::fill_descriptor_writes(unsigned index, vector<char> &buffer) const
 287 {
 288         const PipelineState &self = *static_cast<const PipelineState *>(this);
 289
 290         unsigned n_buffers = 0;
 291         for(const PipelineState::BoundUniformBlock &u: self.uniform_blocks)
 292                 if(u.used && u.binding>=0 && static_cast<unsigned>(u.binding>>20)==index)
 293                         ++n_buffers;
 294         unsigned n_images = 0;
 295         for(const PipelineState::BoundTexture &t: self.textures)
 296                 if(t.used && (t.binding>>20)==index)
 297                         ++n_images;
 298         unsigned n_writes = n_buffers+n_images;
 299
 300         StructureBuilder sb(buffer, 3);
 301         VkWriteDescriptorSet *&writes = sb.add<VkWriteDescriptorSet>(n_writes);
 302         VkDescriptorBufferInfo *&buffers = sb.add<VkDescriptorBufferInfo>(n_buffers);
 303         VkDescriptorImageInfo *&images = sb.add<VkDescriptorImageInfo>(n_images);
 304
 305         VkWriteDescriptorSet *write_ptr = writes;
 306         VkDescriptorBufferInfo *buffer_ptr = buffers;
 307         VkDescriptorImageInfo *image_ptr = images;
 308
 309         for(const PipelineState::BoundUniformBlock &u: self.uniform_blocks)
 310                 if(u.used && u.binding>=0 && static_cast<unsigned>(u.binding>>20)==index)
 311                 {
 312                         buffer_ptr->buffer = handle_cast<::VkBuffer>(u.buffer->handle);
 313                         buffer_ptr->offset = u.block->get_offset();
 314                         buffer_ptr->range = u.block->get_data_size();
 315
 316                         write_ptr->sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
 317                         write_ptr->dstBinding = u.binding&0xFFFFF;
 318                         write_ptr->descriptorCount = 1;
 319                         write_ptr->descriptorType = VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC;
 320                         write_ptr->pBufferInfo = buffer_ptr;
 321
 322                         ++buffer_ptr;
 323                         ++write_ptr;
 324                 }
 325
 326         for(const PipelineState::BoundTexture &t: self.textures)
 327                 if(t.used && (t.binding>>20)==index)
 328                 {
 329                         image_ptr->sampler = handle_cast<::VkSampler>(t.sampler->handle);
 330                         if(t.level<0)
 331                                 image_ptr->imageView = handle_cast<::VkImageView>(t.texture->view_handle);
 332                         else
 333                                 image_ptr->imageView = handle_cast<::VkImageView>(t.texture->mip_view_handles[t.level]);
 334                         image_ptr->imageLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
 335
 336                         write_ptr->sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
 337                         write_ptr->dstBinding = t.binding&0xFFFFF;
 338                         write_ptr->descriptorCount = 1;
 339                         write_ptr->descriptorType = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER;
 340                         write_ptr->pImageInfo = image_ptr;
 341
 342                         ++image_ptr;
 343                         ++write_ptr;
 344                 }
 345
 346         return n_writes;
 347 }
 348
 349 void VulkanPipelineState::apply(VkCommandBuffer command_buffer, unsigned frame, bool negative_viewport) const
 350 {
 351         const PipelineState &self = *static_cast<const PipelineState *>(this);
 352         const VulkanFunctions &vk = device.get_functions();
 353
 354         vk.CmdBindPipeline(command_buffer, VK_PIPELINE_BIND_POINT_GRAPHICS, handle);
 355         if(const VertexSetup *vs = self.vertex_setup)
 356         {
 357                 vk.CmdBindVertexBuffers(command_buffer, 0, vs->n_bindings, vs->buffers, vs->offsets);
 358                 VkIndexType index_type = static_cast<VkIndexType>(get_vulkan_index_type(vs->get_index_type()));
 359                 vk.CmdBindIndexBuffer(command_buffer, vs->get_index_buffer()->handle, 0, index_type);
 360         }
 361
 362         if(!self.uniform_blocks.empty())
 363         {
 364                 const PipelineState::BoundUniformBlock &first_block = self.uniform_blocks.front();
 365                 if(first_block.used && first_block.binding==ReflectData::PUSH_CONSTANT)
 366                 {
 367                         const UniformBlock &pc_block = *first_block.block;
 368                         vk.CmdPushConstants(command_buffer, self.shprog->layout_handle, self.shprog->stage_flags,
 369                                 pc_block.get_offset(), pc_block.get_data_size(), pc_block.get_data_pointer());
 370                 }
 371         }
 372
 373         if(!descriptor_set_handles.empty())
 374         {
 375                 vector<uint32_t> dynamic_offsets;
 376                 dynamic_offsets.reserve(self.uniform_blocks.size());
 377                 for(const PipelineState::BoundUniformBlock &u: self.uniform_blocks)
 378                         if(u.used && u.binding>=0)
 379                         {
 380                                 if(u.buffer->get_usage()==STREAMING)
 381                                         dynamic_offsets.push_back(frame*u.buffer->get_size());
 382                                 else
 383                                         dynamic_offsets.push_back(0);
 384                         }
 385
 386                 vk.CmdBindDescriptorSets(command_buffer, VK_PIPELINE_BIND_POINT_GRAPHICS, self.shprog->layout_handle,
 387                         0, descriptor_set_handles.size(), descriptor_set_handles.data(), dynamic_offsets.size(), dynamic_offsets.data());
 388         }
 389
 390         Rect fb_rect = self.framebuffer->get_rect();
 391
 392         Rect viewport_rect = fb_rect.intersect(self.viewport);
 393         VkViewport viewport = { };
 394         viewport.x = viewport_rect.left;
 395         viewport.y = viewport_rect.bottom;
 396         viewport.width = viewport_rect.width;
 397         viewport.height = viewport_rect.height;
 398         if(negative_viewport)
 399         {
 400                 viewport.y += viewport.height;
 401                 viewport.height = -viewport.height;
 402         }
 403         viewport.minDepth = 0.0f;
 404         viewport.maxDepth = 1.0f;
 405         vk.CmdSetViewport(command_buffer, 0, 1, &viewport);
 406
 407         Rect scissor_rect = fb_rect.intersect(self.scissor);
 408         VkRect2D scissor = { };
 409         scissor.offset.x = scissor_rect.left;
 410         scissor.offset.y = scissor_rect.bottom;
 411         scissor.extent.width = scissor_rect.width;
 412         scissor.extent.height = scissor_rect.height;
 413         vk.CmdSetScissor(command_buffer, 0, 1, &scissor);
 414 }
 415
 416 } // namespace GL
 417 } // namespace Msp