remove backend wait(timeout) API

The only use of this API was with a timeout 0 to check the fence status. Timeouts other than zero could be very dangerous and since we're not using that feature for now, we just get rid of it. wait() is replaced with getFenceStatus(). It is currently only used by the FrameSkipper. This is not a public API.
google · Aug 15, 2023 · f1b160d · f1b160d
1 parent 3bb52f0
commit f1b160d
Show file tree

Hide file tree

Showing 10 changed files with 14 additions and 21 deletions.
diff --git a/filament/backend/include/private/backend/DriverAPI.inc b/filament/backend/include/private/backend/DriverAPI.inc
@@ -287,7 +287,7 @@ DECL_DRIVER_API_SYNCHRONOUS_N(void, setStreamDimensions, backend::StreamHandle,
 DECL_DRIVER_API_SYNCHRONOUS_N(int64_t, getStreamTimestamp, backend::StreamHandle, stream)
 DECL_DRIVER_API_SYNCHRONOUS_N(void, updateStreams, backend::DriverApi*, driver)
 DECL_DRIVER_API_SYNCHRONOUS_N(void, destroyFence, backend::FenceHandle, fh)
-DECL_DRIVER_API_SYNCHRONOUS_N(backend::FenceStatus, wait, backend::FenceHandle, fh, uint64_t, timeout)
+DECL_DRIVER_API_SYNCHRONOUS_N(backend::FenceStatus, getFenceStatus, backend::FenceHandle, fh)
 DECL_DRIVER_API_SYNCHRONOUS_N(bool, isTextureFormatSupported, backend::TextureFormat, format)
 DECL_DRIVER_API_SYNCHRONOUS_0(bool, isTextureSwizzleSupported)
 DECL_DRIVER_API_SYNCHRONOUS_N(bool, isTextureFormatMipmappable, backend::TextureFormat, format)

diff --git a/filament/backend/src/metal/MetalDriver.mm b/filament/backend/src/metal/MetalDriver.mm
@@ -607,12 +607,12 @@
     }
 }
 
-FenceStatus MetalDriver::wait(Handle<HwFence> fh, uint64_t timeout) {
+FenceStatus MetalDriver::getFenceStatus(Handle<HwFence> fh) {
     auto* fence = handle_cast<MetalFence>(fh);
     if (!fence) {
         return FenceStatus::ERROR;
     }
-    return fence->wait(timeout);
+    return fence->wait(0);
 }
 
 bool MetalDriver::isTextureFormatSupported(TextureFormat format) {

diff --git a/filament/backend/src/noop/NoopDriver.cpp b/filament/backend/src/noop/NoopDriver.cpp
@@ -132,7 +132,7 @@ void NoopDriver::updateStreams(CommandStream* driver) {
 void NoopDriver::destroyFence(Handle<HwFence> fh) {
 }
 
-FenceStatus NoopDriver::wait(Handle<HwFence> fh, uint64_t timeout) {
+FenceStatus NoopDriver::getFenceStatus(Handle<HwFence> fh) {
     return FenceStatus::CONDITION_SATISFIED;
 }
 

diff --git a/filament/backend/src/opengl/OpenGLDriver.cpp b/filament/backend/src/opengl/OpenGLDriver.cpp
@@ -1682,7 +1682,7 @@ void OpenGLDriver::destroyFence(Handle<HwFence> fh) {
     }
 }
 
-FenceStatus OpenGLDriver::wait(Handle<HwFence> fh, uint64_t timeout) {
+FenceStatus OpenGLDriver::getFenceStatus(Handle<HwFence> fh) {
     if (fh) {
         GLFence* f = handle_cast<GLFence*>(fh);
         if (mPlatform.canCreateFence() || mContext.isES2()) {
@@ -1695,14 +1695,13 @@ FenceStatus OpenGLDriver::wait(Handle<HwFence> fh, uint64_t timeout) {
                 // - wait() was called before the fence was asynchronously created.
                 return FenceStatus::TIMEOUT_EXPIRED;
             }
-            return mPlatform.waitFence(f->fence, timeout);
+            return mPlatform.waitFence(f->fence, 0);
         }
 #ifndef FILAMENT_SILENCE_NOT_SUPPORTED_BY_ES2
         else {
             assert_invariant(f->state);
             std::unique_lock lock(f->state->lock);
-            f->state->cond.wait_for(lock,
-                    std::chrono::nanoseconds(timeout), [&state = f->state]() {
+            f->state->cond.wait_for(lock, std::chrono::nanoseconds(0), [&state = f->state]() {
                 return state->status != FenceStatus::TIMEOUT_EXPIRED;
             });
             return f->state->status;

diff --git a/filament/backend/src/vulkan/VulkanDriver.cpp b/filament/backend/src/vulkan/VulkanDriver.cpp
@@ -664,7 +664,7 @@ void VulkanDriver::destroyFence(Handle<HwFence> fh) {
     mHandleAllocator.destruct<VulkanFence>(fh);
 }
 
-FenceStatus VulkanDriver::wait(Handle<HwFence> fh, uint64_t timeout) {
+FenceStatus VulkanDriver::getFenceStatus(Handle<HwFence> fh) {
     auto& cmdfence = mHandleAllocator.handle_cast<VulkanFence*>(fh)->fence;
     if (!cmdfence) {
         // If wait is called before a fence actually exists, we return timeout.  This matches the
@@ -684,7 +684,7 @@ FenceStatus VulkanDriver::wait(Handle<HwFence> fh, uint64_t timeout) {
         lock.unlock();
     }
     VkResult result =
-            vkWaitForFences(mPlatform->getDevice(), 1, &cmdfence->fence, VK_TRUE, timeout);
+            vkWaitForFences(mPlatform->getDevice(), 1, &cmdfence->fence, VK_TRUE, 0);
     return result == VK_SUCCESS ? FenceStatus::CONDITION_SATISFIED : FenceStatus::TIMEOUT_EXPIRED;
 }
 

diff --git a/filament/backend/test/BackendTest.cpp b/filament/backend/test/BackendTest.cpp
@@ -85,13 +85,10 @@ void BackendTest::executeCommands() {
     }
 }
 
-void BackendTest::flushAndWait(uint64_t timeout) {
+void BackendTest::flushAndWait() {
     auto& api = getDriverApi();
-    auto fence = api.createFence();
     api.finish();
     executeCommands();
-    api.wait(fence, timeout);
-    api.destroyFence(fence);
 }
 
 Handle<HwSwapChain> BackendTest::createSwapChain() {

diff --git a/filament/backend/test/BackendTest.h b/filament/backend/test/BackendTest.h
@@ -43,7 +43,7 @@ class BackendTest : public ::testing::Test {
 
     void initializeDriver();
     void executeCommands();
-    void flushAndWait(uint64_t timeout = 1000);
+    void flushAndWait();
 
     filament::backend::Handle<filament::backend::HwSwapChain> createSwapChain();
 

diff --git a/filament/backend/test/ComputeTest.cpp b/filament/backend/test/ComputeTest.cpp
@@ -87,11 +87,8 @@ void ComputeTest::executeCommands() {
     }
 }
 
-void ComputeTest::flushAndWait(uint64_t timeout) {
+void ComputeTest::flushAndWait() {
     auto& api = getDriverApi();
-    auto fence = api.createFence();
     api.finish();
     executeCommands();
-    api.wait(fence, timeout);
-    api.destroyFence(fence);
 }
diff --git a/filament/backend/test/ComputeTest.h b/filament/backend/test/ComputeTest.h
@@ -34,7 +34,7 @@ class ComputeTest : public ::testing::Test {
     void TearDown() override;
 
     void executeCommands();
-    void flushAndWait(uint64_t timeout = 1000);
+    void flushAndWait();
     filament::backend::DriverApi& getDriverApi() { return *commandStream; }
     filament::backend::Driver& getDriver() { return *driver; }
 

diff --git a/filament/src/FrameSkipper.cpp b/filament/src/FrameSkipper.cpp
@@ -43,7 +43,7 @@ bool FrameSkipper::beginFrame(DriverApi& driver) noexcept {
     auto& fences = mDelayedFences;
     auto fence = fences.front();
     if (fence) {
-        auto status = driver.wait(fence, 0);
+        auto status = driver.getFenceStatus(fence);
         if (status == FenceStatus::TIMEOUT_EXPIRED) {
             // Sync not ready, skip frame
             return false;