Fix a threading bug

Author: NBT22

include/luna/lunaTypes.h

@@ -8,6 +8,7 @@
 #ifdef __cplusplus
 extern "C"
 {
+// ReSharper disable CppVariableCanBeMadeConstexpr
 // NOLINTBEGIN(*-macro-usage, *-enum-size, *-use-using)
 #else
 #include <stdbool.h>

src/Buffer.cpp

@@ -43,7 +43,7 @@ static bool sortBufferRegionsByOffsetAscending(const Buffer::BufferRegion &a, co
 
 namespace luna
 {
-void BufferRegionIndex::destroyBuffer(Buffer *buffer)
+void BufferRegionIndex::destroyBuffer_(Buffer *buffer)
 {
     buffer->shouldBeDestroyed_ = true;
     vkDeviceWaitIdle(device);

src/Image.cpp

@@ -202,24 +202,22 @@ VkResult Image::write(const LunaImageWriteInfo &writeInfo) const
     CommandBuffer &commandBuffer = device.commandPools().graphics.commandBuffer(1);
     CHECK_RESULT_RETURN(commandBuffer.ensureIsRecording(luna::device, true));
 
-    const BufferRegionIndex *stagingBufferRegionIndex = stagingBuffer;
-    if (stagingBufferRegionIndex == nullptr || stagingBufferRegionIndex->size() < writeInfo.bytes)
+    if (stagingBuffer == nullptr || stagingBuffer->size() < writeInfo.bytes)
     {
-        if (stagingBufferRegionIndex != nullptr)
+        if (stagingBuffer != nullptr)
         {
-            lunaDestroyBuffer(stagingBufferRegionIndex);
+            lunaDestroyBuffer(stagingBuffer);
         }
         const LunaBufferCreationInfo bufferCreationInfo = {
             .size = writeInfo.bytes,
             .usage = VK_BUFFER_USAGE_TRANSFER_SRC_BIT | VK_BUFFER_USAGE_TRANSFER_DST_BIT,
         };
         LunaBuffer stagingBufferHandle = stagingBuffer;
         CHECK_RESULT_RETURN(lunaCreateBuffer(&bufferCreationInfo, &stagingBufferHandle));
-        stagingBufferRegionIndex = stagingBuffer;
+        stagingBuffer = static_cast<const BufferRegionIndex *>(stagingBufferHandle);
     }
 
-    stagingBufferRegionIndex->bufferRegion()->copyToBuffer(static_cast<const uint8_t *>(writeInfo.pixels),
-                                                           writeInfo.bytes);
+    stagingBuffer->bufferRegion()->copyToBuffer(static_cast<const uint8_t *>(writeInfo.pixels), writeInfo.bytes);
     const uint32_t mipmapLevels = writeInfo.mipmapLevels == 0 ? 1 : writeInfo.mipmapLevels;
     const VkImageSubresourceRange subresourceRange = {
         .aspectMask = aspectMask_,
@@ -265,7 +263,7 @@ VkResult Image::write(const LunaImageWriteInfo &writeInfo) const
         .imageExtent = extent,
     };
     vkCmdCopyBufferToImage(commandBuffer,
-                           *stagingBufferRegionIndex->buffer(),
+                           *stagingBuffer->buffer(),
                            image_,
                            VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL,
                            1,

src/Instance.cpp

@@ -322,6 +322,10 @@ VkResult lunaCreateInstance(const LunaInstanceCreationInfo *creationInfo)
 VkResult lunaDestroyInstance()
 {
     using namespace luna;
+    if (Buffer::BufferRegion::BufferRegionIndex::cleanupThread_.joinable())
+    {
+        Buffer::BufferRegion::BufferRegionIndex::cleanupThread_.join();
+    }
     CHECK_RESULT_RETURN(vkDeviceWaitIdle(device));
 
 
@@ -375,6 +379,10 @@ VkResult lunaDestroyInstance()
     descriptorSets.clear();
 
     bufferRegionIndices.clear();
+    if (Buffer::BufferRegion::BufferRegionIndex::cleanupThread_.joinable())
+    {
+        Buffer::BufferRegion::BufferRegionIndex::cleanupThread_.join();
+    }
     buffers.clear();
     stagingBuffer = nullptr;
 

src/headers/Buffer.hpp

@@ -8,7 +8,9 @@
 #include <cstddef>
 #include <cstdint>
 #include <list>
+#include <luna/lunaInstance.h>
 #include <luna/lunaTypes.h>
+#include <thread>
 #include <vk_mem_alloc.h>
 #include <vulkan/vulkan_core.h>
 
@@ -29,8 +31,12 @@ class Buffer
             public: // BufferRegion public types
                 class BufferRegionIndex
                 {
+                        friend VkResult(::lunaDestroyInstance());
+
                     private: // BufferRegionIndex private static
-                        static void destroyBuffer(Buffer *buffer);
+                        static void destroyBuffer_(Buffer *buffer);
+
+                        static inline std::thread cleanupThread_{};
 
                     public: // BufferRegionIndex public members
                         BufferRegionIndex() = delete;
@@ -114,7 +120,6 @@ using BufferRegionIndex = Buffer::BufferRegion::BufferRegionIndex;
 
 #include <algorithm>
 #include <cassert>
-#include <thread>
 
 namespace luna
 {
@@ -167,8 +172,11 @@ inline BufferRegionIndex::~BufferRegionIndex()
     }
     if (buffer_->regions_.empty())
     {
-        std::thread cleanupThread(destroyBuffer, buffer_);
-        cleanupThread.detach();
+        if (cleanupThread_.joinable())
+        {
+            cleanupThread_.join();
+        }
+        cleanupThread_ = std::thread(destroyBuffer_, buffer_);
     }
 }