igl | vulkan | Detect inconsistent vertex buffer bindings

Summary: Bound vertex buffers should match `VertexInputState` in the rendering pipeline.

Reviewed By: EricGriffith, pixelperfect3

Differential Revision: D49175381

fbshipit-source-id: 64788a02c7e7561b11e7e431623fb35ac515c02d

src/igl/vulkan/RenderCommandEncoder.cpp

@@ -18,6 +18,7 @@
 #include <igl/vulkan/RenderPipelineState.h>
 #include <igl/vulkan/SamplerState.h>
 #include <igl/vulkan/Texture.h>
+#include <igl/vulkan/VertexInputState.h>
 #include <igl/vulkan/VulkanBuffer.h>
 #include <igl/vulkan/VulkanContext.h>
 #include <igl/vulkan/VulkanDevice.h>
@@ -484,6 +485,9 @@ void RenderCommandEncoder::bindBuffer(int index,
   if (isVertexBuffer) {
     IGL_ASSERT(target == BindTarget::kVertex);
     IGL_ASSERT(!isUniformOrStorageBuffer);
+    if (IGL_VERIFY(index < IGL_VERTEX_BINDINGS_MAX)) {
+      isVertexBufferBound_[index] = true;
+    }
     const VkDeviceSize offset = bufferOffset;
     vkCmdBindVertexBuffers(cmdBuffer_, index, 1, &vkBuf, &offset);
   } else if (isUniformOrStorageBuffer) {
@@ -596,6 +600,8 @@ void RenderCommandEncoder::draw(PrimitiveType primitiveType,
     return;
   }
 
+  ensureVertexBuffers();
+
   binder_.updateBindings();
   dynamicState_.setTopology(primitiveTypeToVkPrimitiveTopology(primitiveType));
   bindPipeline();
@@ -620,6 +626,8 @@ void RenderCommandEncoder::drawIndexed(PrimitiveType primitiveType,
     return;
   }
 
+  ensureVertexBuffers();
+
   binder_.updateBindings();
   dynamicState_.setTopology(primitiveTypeToVkPrimitiveTopology(primitiveType));
   bindPipeline();
@@ -656,6 +664,8 @@ void RenderCommandEncoder::multiDrawIndirect(PrimitiveType primitiveType,
                                              uint32_t stride) {
   IGL_PROFILER_FUNCTION();
 
+  ensureVertexBuffers();
+
   binder_.updateBindings();
   dynamicState_.setTopology(primitiveTypeToVkPrimitiveTopology(primitiveType));
   bindPipeline();
@@ -680,6 +690,8 @@ void RenderCommandEncoder::multiDrawIndexedIndirect(PrimitiveType primitiveType,
                                                     uint32_t stride) {
   IGL_PROFILER_FUNCTION();
 
+  ensureVertexBuffers();
+
   binder_.updateBindings();
   dynamicState_.setTopology(primitiveTypeToVkPrimitiveTopology(primitiveType));
   bindPipeline();
@@ -723,5 +735,32 @@ bool RenderCommandEncoder::setDrawCallCountEnabled(bool value) {
   return returnVal;
 }
 
+void RenderCommandEncoder::ensureVertexBuffers() {
+  const igl::vulkan::RenderPipelineState* rps =
+      static_cast<igl::vulkan::RenderPipelineState*>(currentPipeline_.get());
+
+  if (!IGL_VERIFY(rps)) {
+    return;
+  }
+
+  const igl::vulkan::VertexInputState* vi = static_cast<igl::vulkan::VertexInputState*>(
+      rps->getRenderPipelineDesc().vertexInputState.get());
+
+  if (!vi) {
+    // no vertex input is perfectly valid
+    return;
+  }
+
+  const VertexInputStateDesc& desc = vi->desc_;
+
+  for (size_t i = 0; i != desc.numInputBindings; i++) {
+    if (!IGL_VERIFY(isVertexBufferBound_[i])) {
+      IGL_ASSERT_MSG(false,
+                     "Did you forget to call bindBuffer() for one of your vertex input buffers?");
+      IGL_LOG_ERROR("Did you forget to call bindBuffer() for one of your vertex input buffers?");
+    }
+  }
+}
+
 } // namespace vulkan
 } // namespace igl

src/igl/vulkan/RenderCommandEncoder.h

@@ -98,6 +98,7 @@ class RenderCommandEncoder : public IRenderCommandEncoder {
 
  private:
   void bindPipeline();
+  void ensureVertexBuffers();
 
  private:
   VulkanContext& ctx_;
@@ -116,6 +117,8 @@ class RenderCommandEncoder : public IRenderCommandEncoder {
    *  1: All other times */
   uint32_t drawCallCountEnabled_ = 1u;
 
+  bool isVertexBufferBound_[IGL_VERTEX_BUFFER_MAX] = {};
+
  private:
   RenderCommandEncoder(const std::shared_ptr<CommandBuffer>& commandBuffer, VulkanContext& ctx);
 

src/igl/vulkan/VertexInputState.h

@@ -21,6 +21,7 @@ class VertexInputState final : public IVertexInputState {
   ~VertexInputState() override = default;
 
   friend class Device;
+  friend class RenderCommandEncoder;
   friend class RenderPipelineState;
 
  private: