Added config object to engine initialization (google#2057) (google#5470)

BStringhamVRSK · May 11, 2022 · 13d14fe · 13d14fe
1 parent a572a10
commit 13d14fe
Show file tree

Hide file tree

Showing 40 changed files with 274 additions and 110 deletions.
diff --git a/filament/backend/include/backend/Platform.h b/filament/backend/include/backend/Platform.h
@@ -37,6 +37,20 @@ class UTILS_PUBLIC Platform {
         uintptr_t image = 0;
     };
 
+    class DriverConfig {
+    private:
+        size_t mHandleArenaSize;    // size of handle arena in bytes
+
+    public:
+        DriverConfig(const DriverConfig* srcConfig);
+        DriverConfig(uint32_t handleArenaSizeInMB = 0);
+
+        const size_t getHandleArenaSize() const noexcept { return mHandleArenaSize; }
+
+    private:
+        void init(uint32_t handleArenaSizeInMB);
+    };
+
     virtual ~Platform() noexcept;
 
     /**
@@ -56,7 +70,7 @@ class UTILS_PUBLIC Platform {
      *
      * @return nullptr on failure, or a pointer to the newly created driver.
      */
-    virtual backend::Driver* createDriver(void* sharedContext) noexcept = 0;
+    virtual backend::Driver* createDriver(void* sharedContext, const DriverConfig& driverConfig) noexcept = 0;
 
     /**
      * Processes the platform's event queue when called from its primary event-handling thread.

diff --git a/filament/backend/include/private/backend/BackendUtils.h b/filament/backend/include/private/backend/BackendUtils.h
@@ -23,10 +23,6 @@
 
 #include <stddef.h>
 
-#ifndef FILAMENT_MIN_COMMAND_BUFFERS_SIZE_IN_MB
-#    define FILAMENT_MIN_COMMAND_BUFFERS_SIZE_IN_MB 1
-#endif
-
 namespace filament {
 namespace backend {
 

diff --git a/filament/backend/include/private/backend/MetalPlatform.h b/filament/backend/include/private/backend/MetalPlatform.h
@@ -29,7 +29,7 @@ class MetalPlatform : public DefaultPlatform {
 public:
     ~MetalPlatform() override;
 
-    Driver* createDriver(void* sharedContext) noexcept override;
+    Driver* createDriver(void* sharedContext, const Platform::DriverConfig& driverConfig) noexcept override;
     int getOSVersion() const noexcept override { return 0; }
 
     /**

diff --git a/filament/backend/include/private/backend/OpenGLPlatform.h b/filament/backend/include/private/backend/OpenGLPlatform.h
@@ -33,7 +33,7 @@ class OpenGLPlatform : public DefaultPlatform {
      * Derived classes can use this to instantiate the default OpenGLDriver backend.
      * This is typically called from your implementation of createDriver()
      */
-    static Driver* createDefaultDriver(OpenGLPlatform* platform, void* sharedContext);
+    static Driver* createDefaultDriver(OpenGLPlatform* platform, void* sharedContext, const DriverConfig& driverConfig);
 
 public:
     ~OpenGLPlatform() noexcept override;

diff --git a/filament/backend/src/Platform.cpp b/filament/backend/src/Platform.cpp
@@ -78,11 +78,32 @@ filament::backend::DefaultPlatform* createDefaultMetalPlatform();
 #include "noop/PlatformNoop.h"
 
 namespace filament {
+
 namespace backend {
 
 // this generates the vtable in this translation unit
 Platform::~Platform() noexcept = default;
 
+Platform::DriverConfig::DriverConfig(const DriverConfig* srcConfig) {
+    if (srcConfig != nullptr) {
+        *this = *srcConfig;
+    }
+    else {
+        init(0);
+    }
+}
+
+Platform::DriverConfig::DriverConfig(uint32_t handleArenaSizeInMB)
+{
+    init(handleArenaSizeInMB);
+}
+
+void Platform::DriverConfig::init(uint32_t handleArenaSizeInMB) {
+    constexpr size_t MB = 1024 * 1024;
+
+    mHandleArenaSize = handleArenaSizeInMB * MB;
+}
+
 // Creates the platform-specific Platform object. The caller takes ownership and is
 // responsible for destroying it. Initialization of the backend API is deferred until
 // createDriver(). The passed-in backend hint is replaced with the resolved backend.

diff --git a/filament/backend/src/metal/MetalDriver.h b/filament/backend/src/metal/MetalDriver.h
@@ -42,12 +42,13 @@ struct UniformBufferState;
 #endif
 
 class MetalDriver final : public DriverBase {
-    explicit MetalDriver(MetalPlatform* platform) noexcept;
+    explicit MetalDriver(MetalPlatform* platform, const Platform::DriverConfig& driverConfig) noexcept;
     ~MetalDriver() noexcept override;
     Dispatcher getDispatcher() const noexcept final;
 
 public:
-    static Driver* create(MetalPlatform* platform);
+    static Driver* create(MetalPlatform* platform, const Platform::DriverConfig& driverConfig);
+    static size_t getHandleArenaSize(const Platform::DriverConfig& driverConfig) noexcept;
 
 private:
 

diff --git a/filament/backend/src/metal/MetalDriver.mm b/filament/backend/src/metal/MetalDriver.mm
@@ -40,24 +40,30 @@
 namespace filament {
 namespace backend {
 
-Driver* MetalDriverFactory::create(MetalPlatform* const platform) {
-    return MetalDriver::create(platform);
+Driver* MetalDriverFactory::create(MetalPlatform* const platform, const Platform::DriverConfig& driverConfig) {
+    return MetalDriver::create(platform, driverConfig);
 }
 
 UTILS_NOINLINE
-Driver* MetalDriver::create(MetalPlatform* const platform) {
+Driver* MetalDriver::create(MetalPlatform* const platform, const Platform::DriverConfig& driverConfig) {
     assert_invariant(platform);
-    return new MetalDriver(platform);
+    return new MetalDriver(platform, driverConfig);
+}
+
+size_t MetalDriver::getHandleArenaSize(const Platform::DriverConfig& driverConfig) noexcept {
+    size_t configSize = driverConfig.getHandleArenaSize();
+    size_t defaultSize = FILAMENT_METAL_HANDLE_ARENA_SIZE_IN_MB * 1024U * 1024U;
+    return configSize > defaultSize ? configSize : defaultSize;
 }
 
 Dispatcher MetalDriver::getDispatcher() const noexcept {
     return ConcreteDispatcher<MetalDriver>::make();
 }
 
-MetalDriver::MetalDriver(MetalPlatform* platform) noexcept
+MetalDriver::MetalDriver(MetalPlatform* platform, const Platform::DriverConfig& driverConfig) noexcept
         : mPlatform(*platform),
           mContext(new MetalContext),
-          mHandleAllocator("Handles", FILAMENT_METAL_HANDLE_ARENA_SIZE_IN_MB * 1024U * 1024U) {
+          mHandleAllocator("Handles", getHandleArenaSize(driverConfig)) {
     mContext->driver = this;
 
     mContext->device = mPlatform.createDevice();

diff --git a/filament/backend/src/metal/MetalDriverFactory.h b/filament/backend/src/metal/MetalDriverFactory.h
@@ -24,7 +24,7 @@ class Driver;
 
 class MetalDriverFactory {
 public:
-    static Driver* create(MetalPlatform* platform);
+    static Driver* create(MetalPlatform* platform, const Platform::DriverConfig& driverConfig);
 };
 
 } // namespace backend

diff --git a/filament/backend/src/metal/MetalPlatform.mm b/filament/backend/src/metal/MetalPlatform.mm
@@ -31,8 +31,8 @@
 
 MetalPlatform::~MetalPlatform() = default;
 
-Driver* MetalPlatform::createDriver(void* sharedContext) noexcept {
-    return MetalDriverFactory::create(this);
+Driver* MetalPlatform::createDriver(void* sharedContext, const Platform::DriverConfig& driverConfig) noexcept {
+    return MetalDriverFactory::create(this, driverConfig);
 }
 
 id<MTLDevice> MetalPlatform::createDevice() noexcept {

diff --git a/filament/backend/src/noop/PlatformNoop.cpp b/filament/backend/src/noop/PlatformNoop.cpp
@@ -20,7 +20,7 @@
 
 namespace filament::backend {
 
-Driver* PlatformNoop::createDriver(void* const sharedGLContext) noexcept {
+Driver* PlatformNoop::createDriver(void* const sharedGLContext, const Platform::DriverConfig& driverConfig) noexcept {
     return NoopDriver::create();
 }
 

diff --git a/filament/backend/src/noop/PlatformNoop.h b/filament/backend/src/noop/PlatformNoop.h
@@ -31,7 +31,7 @@ class PlatformNoop final : public DefaultPlatform {
 
 protected:
 
-    Driver* createDriver(void* sharedContext) noexcept override;
+    Driver* createDriver(void* sharedContext, const Platform::DriverConfig& driverConfig) noexcept override;
 };
 
 } // namespace filament

diff --git a/filament/backend/src/opengl/OpenGLDriver.cpp b/filament/backend/src/opengl/OpenGLDriver.cpp
@@ -63,8 +63,8 @@ using namespace utils;
 namespace filament::backend {
 
 Driver* OpenGLDriverFactory::create(
-        OpenGLPlatform* const platform, void* const sharedGLContext) noexcept {
-    return OpenGLDriver::create(platform, sharedGLContext);
+        OpenGLPlatform* const platform, void* const sharedGLContext, const Platform::DriverConfig& driverConfig) noexcept {
+    return OpenGLDriver::create(platform, sharedGLContext, driverConfig);
 }
 
 using namespace GLUtils;
@@ -73,7 +73,7 @@ using namespace GLUtils;
 
 UTILS_NOINLINE
 Driver* OpenGLDriver::create(
-        OpenGLPlatform* const platform, void* const sharedGLContext) noexcept {
+        OpenGLPlatform* const platform, void* const sharedGLContext, const Platform::DriverConfig& driverConfig) noexcept {
     assert_invariant(platform);
     OpenGLPlatform* const ec = platform;
 
@@ -136,10 +136,17 @@ Driver* OpenGLDriver::create(
         }
     }
 
-    OpenGLDriver* const driver = new OpenGLDriver(ec);
+    OpenGLDriver* const driver = new OpenGLDriver(ec, driverConfig);
     return driver;
 }
 
+size_t OpenGLDriver::getHandleArenaSize(const Platform::DriverConfig& driverConfig) noexcept {
+    size_t configSize = driverConfig.getHandleArenaSize();
+    size_t defaultSize = FILAMENT_OPENGL_HANDLE_ARENA_SIZE_IN_MB * 1024U * 1024U;
+    return configSize > defaultSize ? configSize : defaultSize;
+}
+
+
 // ------------------------------------------------------------------------------------------------
 
 OpenGLDriver::DebugMarker::DebugMarker(OpenGLDriver& driver, const char* string) noexcept
@@ -153,8 +160,8 @@ OpenGLDriver::DebugMarker::~DebugMarker() noexcept {
 
 // ------------------------------------------------------------------------------------------------
 
-OpenGLDriver::OpenGLDriver(OpenGLPlatform* platform) noexcept
-        : mHandleAllocator("Handles", FILAMENT_OPENGL_HANDLE_ARENA_SIZE_IN_MB * 1024U * 1024U), // TODO: set the amount in configuration
+OpenGLDriver::OpenGLDriver(OpenGLPlatform* platform, const Platform::DriverConfig& driverConfig) noexcept
+        : mHandleAllocator("Handles", getHandleArenaSize(driverConfig)),
           mSamplerMap(32),
           mPlatform(*platform) {
 

diff --git a/filament/backend/src/opengl/OpenGLDriver.h b/filament/backend/src/opengl/OpenGLDriver.h
@@ -52,12 +52,13 @@ class OpenGLBlitter;
 class OpenGLTimerQueryInterface;
 
 class OpenGLDriver final : public DriverBase {
-    inline explicit OpenGLDriver(OpenGLPlatform* platform) noexcept;
+    inline explicit OpenGLDriver(OpenGLPlatform* platform, const Platform::DriverConfig& driverConfig) noexcept;
     ~OpenGLDriver() noexcept final;
     Dispatcher getDispatcher() const noexcept final;
 
 public:
-    static Driver* create(OpenGLPlatform* platform, void* sharedGLContext) noexcept;
+    static Driver* create(OpenGLPlatform* platform, void* sharedGLContext, const Platform::DriverConfig& driverConfig) noexcept;
+    static size_t getHandleArenaSize(const Platform::DriverConfig& driverConfig) noexcept;
 
     class DebugMarker {
         OpenGLDriver& driver;

diff --git a/filament/backend/src/opengl/OpenGLDriverFactory.h b/filament/backend/src/opengl/OpenGLDriverFactory.h
@@ -24,7 +24,7 @@ class Driver;
 
 class OpenGLDriverFactory {
 public:
-    static Driver* create(OpenGLPlatform* platform, void* sharedGLContext) noexcept;
+    static Driver* create(OpenGLPlatform* platform, void* sharedGLContext, const Platform::DriverConfig& driverConfig) noexcept;
 };
 
 } // namespace filament::backend

diff --git a/filament/backend/src/opengl/OpenGLPlatform.cpp b/filament/backend/src/opengl/OpenGLPlatform.cpp
@@ -22,8 +22,8 @@ namespace filament::backend {
 
 OpenGLPlatform::~OpenGLPlatform() noexcept = default;
 
-Driver* OpenGLPlatform::createDefaultDriver(OpenGLPlatform* platform, void* sharedContext) {
-    return OpenGLDriverFactory::create(platform, sharedContext);
+Driver* OpenGLPlatform::createDefaultDriver(OpenGLPlatform* platform, void* sharedContext, const Platform::DriverConfig& driverConfig) {
+    return OpenGLDriverFactory::create(platform, sharedContext, driverConfig);
 }
 
 } // namespace filament::backend
diff --git a/filament/backend/src/opengl/platforms/PlatformWGL.cpp b/filament/backend/src/opengl/platforms/PlatformWGL.cpp
@@ -76,7 +76,7 @@ struct WGLSwapChain {
     bool isHeadless = false;
 };
 
-Driver* PlatformWGL::createDriver(void* const sharedGLContext) noexcept {
+Driver* PlatformWGL::createDriver(void* const sharedGLContext, const Platform::DriverConfig& driverConfig) noexcept {
     int result = 0;
     PFNWGLCREATECONTEXTATTRIBSARBPROC wglCreateContextAttribs = nullptr;
     int pixelFormat = 0;
@@ -147,7 +147,7 @@ Driver* PlatformWGL::createDriver(void* const sharedGLContext) noexcept {
 
     result = bluegl::bind();
     ASSERT_POSTCONDITION(!result, "Unable to load OpenGL entry points.");
-    return OpenGLDriverFactory::create(this, sharedGLContext);
+    return OpenGLDriverFactory::create(this, sharedGLContext, driverConfig);
 
 error:
     if (tempContext) {

diff --git a/filament/backend/src/opengl/platforms/PlatformWGL.h b/filament/backend/src/opengl/platforms/PlatformWGL.h
@@ -30,7 +30,7 @@ namespace filament::backend {
 
 class PlatformWGL final : public OpenGLPlatform {
 public:
-    Driver* createDriver(void* const sharedGLContext) noexcept override;
+    Driver* createDriver(void* const sharedGLContext, const Platform::DriverConfig& driverConfig) noexcept override;
     void terminate() noexcept override;
 
     SwapChain* createSwapChain(void* nativewindow, uint64_t& flags) noexcept override;

diff --git a/filament/backend/src/opengl/platforms/PlatformWebGL.cpp b/filament/backend/src/opengl/platforms/PlatformWebGL.cpp
@@ -21,8 +21,8 @@ namespace filament::backend {
 
 using namespace backend;
 
-Driver* PlatformWebGL::createDriver(void* const sharedGLContext) noexcept {
-    return OpenGLDriverFactory::create(this, sharedGLContext);
+Driver* PlatformWebGL::createDriver(void* const sharedGLContext, const Platform::DriverConfig& driverConfig) noexcept {
+    return OpenGLDriverFactory::create(this, sharedGLContext, driverConfig);
 }
 
 void PlatformWebGL::terminate() noexcept {

diff --git a/filament/backend/src/opengl/platforms/PlatformWebGL.h b/filament/backend/src/opengl/platforms/PlatformWebGL.h
@@ -31,7 +31,7 @@ namespace filament::backend {
 class PlatformWebGL final : public OpenGLPlatform {
 public:
 
-    Driver* createDriver(void* const sharedGLContext) noexcept override;
+    Driver* createDriver(void* const sharedGLContext, const Platform::DriverConfig& driverConfig) noexcept override;
     void terminate() noexcept override;
 
     SwapChain* createSwapChain(void* nativewindow, uint64_t& flags) noexcept final override;

diff --git a/filament/backend/src/vulkan/PlatformVkAndroid.cpp b/filament/backend/src/vulkan/PlatformVkAndroid.cpp
@@ -29,10 +29,10 @@ using namespace bluevk;
 
 namespace filament::backend {
 
-Driver* PlatformVkAndroid::createDriver(void* const sharedContext) noexcept {
+Driver* PlatformVkAndroid::createDriver(void* const sharedContext, const Platform::DriverConfig& driverConfig) noexcept {
     ASSERT_PRECONDITION(sharedContext == nullptr, "Vulkan does not support shared contexts.");
     static const char* requiredInstanceExtensions[] = { "VK_KHR_android_surface" };
-    return VulkanDriverFactory::create(this, requiredInstanceExtensions, 1);
+    return VulkanDriverFactory::create(this, requiredInstanceExtensions, 1, driverConfig);
 }
 
 void* PlatformVkAndroid::createVkSurfaceKHR(void* nativeWindow, void* vkinstance, uint64_t flags) noexcept {

diff --git a/filament/backend/src/vulkan/PlatformVkAndroid.h b/filament/backend/src/vulkan/PlatformVkAndroid.h
@@ -27,7 +27,7 @@ namespace filament::backend {
 class PlatformVkAndroid final : public VulkanPlatform {
 public:
 
-    Driver* createDriver(void* const sharedContext) noexcept override;
+    Driver* createDriver(void* const sharedContext, const Platform::DriverConfig& driverConfig) noexcept override;
 
     void* createVkSurfaceKHR(void* nativeWindow, void* instance, uint64_t flags) noexcept override;
 

diff --git a/filament/backend/src/vulkan/PlatformVkCocoa.h b/filament/backend/src/vulkan/PlatformVkCocoa.h
@@ -26,7 +26,7 @@ namespace filament::backend {
 
 class PlatformVkCocoa final : public VulkanPlatform {
 public:
-    Driver* createDriver(void* sharedContext) noexcept override;
+    Driver* createDriver(void* sharedContext, const Platform::DriverConfig& driverConfig) noexcept override;
     void* createVkSurfaceKHR(void* nativeWindow, void* instance, uint64_t flags) noexcept override;
     int getOSVersion() const noexcept override { return 0; }
 };

diff --git a/filament/backend/src/vulkan/PlatformVkCocoa.mm b/filament/backend/src/vulkan/PlatformVkCocoa.mm
@@ -34,12 +34,12 @@
 
 namespace filament::backend {
 
-Driver* PlatformVkCocoa::createDriver(void* sharedContext) noexcept {
+Driver* PlatformVkCocoa::createDriver(void* sharedContext, const Platform::DriverConfig& driverConfig) noexcept {
     ASSERT_PRECONDITION(sharedContext == nullptr, "Vulkan does not support shared contexts.");
     static const char* requiredInstanceExtensions[] = {
         "VK_MVK_macos_surface", // TODO: replace with VK_EXT_metal_surface
     };
-    return VulkanDriverFactory::create(this, requiredInstanceExtensions, 1);
+    return VulkanDriverFactory::create(this, requiredInstanceExtensions, 1, driverConfig);
 }
 
 void* PlatformVkCocoa::createVkSurfaceKHR(void* nativeWindow, void* instance, uint64_t flags) noexcept {

diff --git a/filament/backend/src/vulkan/PlatformVkCocoaTouch.h b/filament/backend/src/vulkan/PlatformVkCocoaTouch.h
@@ -26,7 +26,7 @@ namespace filament::backend {
 
 class PlatformVkCocoaTouch final : public VulkanPlatform {
 public:
-    Driver* createDriver(void* const sharedContext) noexcept override;
+    Driver* createDriver(void* const sharedContext, const Platform::DriverConfig& driverConfig) noexcept override;
     void* createVkSurfaceKHR(void* nativeWindow, void* instance, uint64_t flags) noexcept override;
     int getOSVersion() const noexcept override { return 0; }
 };

diff --git a/filament/backend/src/vulkan/PlatformVkCocoaTouch.mm b/filament/backend/src/vulkan/PlatformVkCocoaTouch.mm
@@ -39,10 +39,10 @@
 
 namespace filament::backend {
 
-Driver* PlatformVkCocoaTouch::createDriver(void* const sharedContext) noexcept {
+Driver* PlatformVkCocoaTouch::createDriver(void* const sharedContext, const Platform::DriverConfig& driverConfig) noexcept {
     ASSERT_PRECONDITION(sharedContext == nullptr, "Vulkan does not support shared contexts.");
     static const char* requestedExtensions[] = {"VK_MVK_ios_surface"};
-    return VulkanDriverFactory::create(this, requestedExtensions, 1);
+    return VulkanDriverFactory::create(this, requestedExtensions, 1, driverConfig);
 }
 
 void* PlatformVkCocoaTouch::createVkSurfaceKHR(void* nativeWindow, void* instance, uint64_t flags) noexcept {

diff --git a/filament/backend/src/vulkan/PlatformVkLinuxWayland.cpp b/filament/backend/src/vulkan/PlatformVkLinuxWayland.cpp
@@ -29,13 +29,13 @@ using namespace bluevk;
 
 namespace filament::backend {
 
-Driver* PlatformVkLinuxWayland::createDriver(void* const sharedContext) noexcept {
+Driver* PlatformVkLinuxWayland::createDriver(void* const sharedContext, const Platform::DriverConfig& driverConfig) noexcept {
     ASSERT_PRECONDITION(sharedContext == nullptr, "Vulkan does not support shared contexts.");
     const char* requiredInstanceExtensions[] = {
         "VK_KHR_wayland_surface",
     };
     return VulkanDriverFactory::create(this, requiredInstanceExtensions,
-            sizeof(requiredInstanceExtensions) / sizeof(requiredInstanceExtensions[0]));
+            sizeof(requiredInstanceExtensions) / sizeof(requiredInstanceExtensions[0]), driverConfig);
 }
 
 void* PlatformVkLinuxWayland::createVkSurfaceKHR(void* nativeWindow, void* instance, uint64_t flags) noexcept {