Add workaround for validation layer memory leak

Overv · Overv · commit a18838e13e60 · 2017-05-31T22:02:36.000+02:00
diff --git a/03_Drawing_a_triangle/03_Drawing/02_Rendering_and_presentation.md b/03_Drawing_a_triangle/03_Drawing/02_Rendering_and_presentation.md
@@ -348,6 +348,27 @@ You can also wait for operations in a specific command queue to be finished with
 perform synchronization. You'll see that the program now exits without problems
 when closing the window.
 
+## Memory leak
+
+If you run your application with validation layers enabled and you monitor the
+memory usage of your application, you may notice that it is slowly growing. The
+reason for this is that the validation layer implementation expects the
+application to explicitly synchronize with the GPU. Although this is technically
+not required, doing so once a frame will not noticeably affect performance.
+
+We can do this by explicitly waiting for presentation to finish before starting
+to draw the next frame:
+
+```c++
+void drawFrame() {
+    ...
+
+    vkQueuePresentKHR(presentQueue, &presentInfo);
+
+    vkQueueWaitIdle(presentQueue);
+}
+```
+
 ## Conclusion
 
 About 800 lines of code later, we've finally gotten to the stage of seeing
diff --git a/03_Drawing_a_triangle/04_Swap_chain_recreation.md b/03_Drawing_a_triangle/04_Swap_chain_recreation.md
@@ -204,6 +204,8 @@ if (result == VK_ERROR_OUT_OF_DATE_KHR || result == VK_SUBOPTIMAL_KHR) {
 } else if (result != VK_SUCCESS) {
     throw std::runtime_error("failed to present swap chain image!");
 }
+
+vkQueueWaitIdle(presentQueue);
 ```
 
 The `vkQueuePresentKHR` function returns the same values with the same meaning.
diff --git a/code/depth_buffering.cpp b/code/depth_buffering.cpp
@@ -1283,6 +1283,8 @@ class HelloTriangleApplication {
         } else if (result != VK_SUCCESS) {
             throw std::runtime_error("failed to present swap chain image!");
         }
+
+        vkQueueWaitIdle(presentQueue);
     }
 
     VkShaderModule createShaderModule(const std::vector<char>& code) {
diff --git a/code/descriptor_layout.cpp b/code/descriptor_layout.cpp
@@ -922,6 +922,8 @@ class HelloTriangleApplication {
         } else if (result != VK_SUCCESS) {
             throw std::runtime_error("failed to present swap chain image!");
         }
+
+        vkQueueWaitIdle(presentQueue);
     }
 
     VkShaderModule createShaderModule(const std::vector<char>& code) {
diff --git a/code/descriptor_set.cpp b/code/descriptor_set.cpp
@@ -976,6 +976,8 @@ class HelloTriangleApplication {
         } else if (result != VK_SUCCESS) {
             throw std::runtime_error("failed to present swap chain image!");
         }
+
+        vkQueueWaitIdle(presentQueue);
     }
 
     VkShaderModule createShaderModule(const std::vector<char>& code) {
diff --git a/code/hello_triangle.cpp b/code/hello_triangle.cpp
@@ -638,6 +638,8 @@ class HelloTriangleApplication {
         presentInfo.pImageIndices = &imageIndex;
 
         vkQueuePresentKHR(presentQueue, &presentInfo);
+
+        vkQueueWaitIdle(presentQueue);
     }
 
     VkShaderModule createShaderModule(const std::vector<char>& code) {
diff --git a/code/index_buffer.cpp b/code/index_buffer.cpp
@@ -860,6 +860,8 @@ class HelloTriangleApplication {
         } else if (result != VK_SUCCESS) {
             throw std::runtime_error("failed to present swap chain image!");
         }
+
+        vkQueueWaitIdle(presentQueue);
     }
 
     VkShaderModule createShaderModule(const std::vector<char>& code) {
diff --git a/code/model_loading.cpp b/code/model_loading.cpp
@@ -1328,6 +1328,8 @@ class HelloTriangleApplication {
         } else if (result != VK_SUCCESS) {
             throw std::runtime_error("failed to present swap chain image!");
         }
+
+        vkQueueWaitIdle(presentQueue);
     }
 
     VkShaderModule createShaderModule(const std::vector<char>& code) {
diff --git a/code/sampler.cpp b/code/sampler.cpp
@@ -1158,6 +1158,8 @@ class HelloTriangleApplication {
         } else if (result != VK_SUCCESS) {
             throw std::runtime_error("failed to present swap chain image!");
         }
+
+        vkQueueWaitIdle(presentQueue);
     }
 
     VkShaderModule createShaderModule(const std::vector<char>& code) {
diff --git a/code/staging_buffer.cpp b/code/staging_buffer.cpp
@@ -827,6 +827,8 @@ class HelloTriangleApplication {
         } else if (result != VK_SUCCESS) {
             throw std::runtime_error("failed to present swap chain image!");
         }
+
+        vkQueueWaitIdle(presentQueue);
     }
 
     VkShaderModule createShaderModule(const std::vector<char>& code) {
diff --git a/code/swap_chain_recreation.cpp b/code/swap_chain_recreation.cpp
@@ -678,6 +678,8 @@ class HelloTriangleApplication {
         } else if (result != VK_SUCCESS) {
             throw std::runtime_error("failed to present swap chain image!");
         }
+
+        vkQueueWaitIdle(presentQueue);
     }
 
     VkShaderModule createShaderModule(const std::vector<char>& code) {
diff --git a/code/texture_image.cpp b/code/texture_image.cpp
@@ -1122,6 +1122,8 @@ class HelloTriangleApplication {
         } else if (result != VK_SUCCESS) {
             throw std::runtime_error("failed to present swap chain image!");
         }
+
+        vkQueueWaitIdle(presentQueue);
     }
 
     VkShaderModule createShaderModule(const std::vector<char>& code) {
diff --git a/code/texture_mapping.cpp b/code/texture_mapping.cpp
@@ -1188,6 +1188,8 @@ class HelloTriangleApplication {
         } else if (result != VK_SUCCESS) {
             throw std::runtime_error("failed to present swap chain image!");
         }
+
+        vkQueueWaitIdle(presentQueue);
     }
 
     VkShaderModule createShaderModule(const std::vector<char>& code) {
diff --git a/code/vertex_buffer.cpp b/code/vertex_buffer.cpp
@@ -779,6 +779,8 @@ class HelloTriangleApplication {
         } else if (result != VK_SUCCESS) {
             throw std::runtime_error("failed to present swap chain image!");
         }
+
+        vkQueueWaitIdle(presentQueue);
     }
 
     VkShaderModule createShaderModule(const std::vector<char>& code) {
diff --git a/code/vertex_input.cpp b/code/vertex_input.cpp
@@ -723,6 +723,8 @@ class HelloTriangleApplication {
         } else if (result != VK_SUCCESS) {
             throw std::runtime_error("failed to present swap chain image!");
         }
+
+        vkQueueWaitIdle(presentQueue);
     }
 
     VkShaderModule createShaderModule(const std::vector<char>& code) {

Original file line number	Diff line number	Diff line change
`@@ -204,6 +204,8 @@ if (result == VK_ERROR_OUT_OF_DATE_KHR \|\| result == VK_SUBOPTIMAL_KHR) {`
`204`	`204`	`} else if (result != VK_SUCCESS) {`
`205`	`205`	`throw std::runtime_error("failed to present swap chain image!");`
`206`	`206`	`}`
	`207`	`+`
	`208`	`+vkQueueWaitIdle(presentQueue);`
`207`	`209`	```
`208`	`210`
`209`	`211`	The `vkQueuePresentKHR` function returns the same values with the same meaning.
Original file line number	Diff line number	Diff line change
`@@ -1283,6 +1283,8 @@ class HelloTriangleApplication {`
`1283`	`1283`	`} else if (result != VK_SUCCESS) {`
`1284`	`1284`	`throw std::runtime_error("failed to present swap chain image!");`
`1285`	`1285`	`}`
	`1286`	`+`
	`1287`	`+ vkQueueWaitIdle(presentQueue);`
`1286`	`1288`	`}`
`1287`	`1289`
`1288`	`1290`	`VkShaderModule createShaderModule(const std::vector<char>& code) {`
Original file line number	Diff line number	Diff line change
`@@ -922,6 +922,8 @@ class HelloTriangleApplication {`
`922`	`922`	`} else if (result != VK_SUCCESS) {`
`923`	`923`	`throw std::runtime_error("failed to present swap chain image!");`
`924`	`924`	`}`
	`925`	`+`
	`926`	`+ vkQueueWaitIdle(presentQueue);`
`925`	`927`	`}`
`926`	`928`
`927`	`929`	`VkShaderModule createShaderModule(const std::vector<char>& code) {`
Original file line number	Diff line number	Diff line change
`@@ -976,6 +976,8 @@ class HelloTriangleApplication {`
`976`	`976`	`} else if (result != VK_SUCCESS) {`
`977`	`977`	`throw std::runtime_error("failed to present swap chain image!");`
`978`	`978`	`}`
	`979`	`+`
	`980`	`+ vkQueueWaitIdle(presentQueue);`
`979`	`981`	`}`
`980`	`982`
`981`	`983`	`VkShaderModule createShaderModule(const std::vector<char>& code) {`
Original file line number	Diff line number	Diff line change
`@@ -638,6 +638,8 @@ class HelloTriangleApplication {`
`638`	`638`	`presentInfo.pImageIndices = &imageIndex;`
`639`	`639`
`640`	`640`	`vkQueuePresentKHR(presentQueue, &presentInfo);`
	`641`	`+`
	`642`	`+ vkQueueWaitIdle(presentQueue);`
`641`	`643`	`}`
`642`	`644`
`643`	`645`	`VkShaderModule createShaderModule(const std::vector<char>& code) {`
Original file line number	Diff line number	Diff line change
`@@ -860,6 +860,8 @@ class HelloTriangleApplication {`
`860`	`860`	`} else if (result != VK_SUCCESS) {`
`861`	`861`	`throw std::runtime_error("failed to present swap chain image!");`
`862`	`862`	`}`
	`863`	`+`
	`864`	`+ vkQueueWaitIdle(presentQueue);`
`863`	`865`	`}`
`864`	`866`
`865`	`867`	`VkShaderModule createShaderModule(const std::vector<char>& code) {`
Original file line number	Diff line number	Diff line change
`@@ -1328,6 +1328,8 @@ class HelloTriangleApplication {`
`1328`	`1328`	`} else if (result != VK_SUCCESS) {`
`1329`	`1329`	`throw std::runtime_error("failed to present swap chain image!");`
`1330`	`1330`	`}`
	`1331`	`+`
	`1332`	`+ vkQueueWaitIdle(presentQueue);`
`1331`	`1333`	`}`
`1332`	`1334`
`1333`	`1335`	`VkShaderModule createShaderModule(const std::vector<char>& code) {`
Original file line number	Diff line number	Diff line change
`@@ -1158,6 +1158,8 @@ class HelloTriangleApplication {`
`1158`	`1158`	`} else if (result != VK_SUCCESS) {`
`1159`	`1159`	`throw std::runtime_error("failed to present swap chain image!");`
`1160`	`1160`	`}`
	`1161`	`+`
	`1162`	`+ vkQueueWaitIdle(presentQueue);`
`1161`	`1163`	`}`
`1162`	`1164`
`1163`	`1165`	`VkShaderModule createShaderModule(const std::vector<char>& code) {`
Original file line number	Diff line number	Diff line change
`@@ -827,6 +827,8 @@ class HelloTriangleApplication {`
`827`	`827`	`} else if (result != VK_SUCCESS) {`
`828`	`828`	`throw std::runtime_error("failed to present swap chain image!");`
`829`	`829`	`}`
	`830`	`+`
	`831`	`+ vkQueueWaitIdle(presentQueue);`
`830`	`832`	`}`
`831`	`833`
`832`	`834`	`VkShaderModule createShaderModule(const std::vector<char>& code) {`