Log excess buffer allocations for Metal

google · May 7, 2024 · c0ee1e2 · c0ee1e2
1 parent 1b9d2c6
commit c0ee1e2
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/filament/backend/src/metal/MetalBuffer.h b/filament/backend/src/metal/MetalBuffer.h
@@ -18,6 +18,7 @@
 #define TNT_FILAMENT_DRIVER_METALBUFFER_H
 
 #include "MetalContext.h"
+#include "MetalPlatform.h"
 
 #include <backend/DriverEnums.h>
 
@@ -34,6 +35,8 @@ namespace filament::backend {
 class TrackedMetalBuffer {
 public:
 
+    static constexpr size_t EXCESS_BUFFER_COUNT = 30000;
+
     enum class Type {
         NONE = 0,
         GENERIC = 1,
@@ -62,6 +65,12 @@ class TrackedMetalBuffer {
         if (buffer) {
             aliveBuffers[toIndex(type)]++;
             mType = type;
+            if (getAliveBuffers() >= EXCESS_BUFFER_COUNT) {
+                if (platform && platform->hasDebugUpdateStatFunc()) {
+                    platform->debugUpdateStat("filament.metal.excess_buffers_allocated",
+                            TrackedMetalBuffer::getAliveBuffers());
+                }
+            }
         }
     }
 
@@ -96,6 +105,7 @@ class TrackedMetalBuffer {
         assert_invariant(type != Type::NONE);
         return aliveBuffers[toIndex(type)];
     }
+    static void setPlatform(MetalPlatform* p) { platform = p; }
 
 private:
     void swap(TrackedMetalBuffer& other) noexcept {
@@ -106,6 +116,7 @@ class TrackedMetalBuffer {
     id<MTLBuffer> mBuffer;
     Type mType = Type::NONE;
 
+    static MetalPlatform* platform;
     static std::array<uint64_t, TypeCount> aliveBuffers;
 };
 

diff --git a/filament/backend/src/metal/MetalBuffer.mm b/filament/backend/src/metal/MetalBuffer.mm
@@ -23,6 +23,7 @@
 namespace backend {
 
 std::array<uint64_t, TrackedMetalBuffer::TypeCount> TrackedMetalBuffer::aliveBuffers = { 0 };
+MetalPlatform* TrackedMetalBuffer::platform = nullptr;
 
 MetalBuffer::MetalBuffer(MetalContext& context, BufferObjectBinding bindingType, BufferUsage usage,
         size_t size, bool forceGpuBuffer) : mBufferSize(size), mContext(context) {

diff --git a/filament/backend/src/metal/MetalDriver.mm b/filament/backend/src/metal/MetalDriver.mm
@@ -105,6 +105,8 @@
                   driverConfig.disableHandleUseAfterFreeCheck) {
     mContext->driver = this;
 
+    TrackedMetalBuffer::setPlatform(platform);
+
     mContext->device = mPlatform.createDevice();
     assert_invariant(mContext->device);
 
@@ -198,6 +200,7 @@
 }
 
 MetalDriver::~MetalDriver() noexcept {
+    TrackedMetalBuffer::setPlatform(nullptr);
     mContext->device = nil;
     mContext->emptyTexture = nil;
     CFRelease(mContext->textureCache);