Skip to content

Commit 2c9accd

Browse files
[Impeller] Port a recent Vulkan swapchain fence waiting fix to the AHB version of the swapchain (#185763)
WaitForFence should only wait if there is a pending frame presentation that will cause the fence to become signaled. This was fixed in the KHR swapchain by c5d0a84. This PR implements the same fix for the AHB swapchain and adds a unit test for AHBSwapchainVK.
1 parent b0e66e6 commit 2c9accd

14 files changed

Lines changed: 278 additions & 97 deletions

File tree

‎engine/src/flutter/impeller/renderer/backend/vulkan/BUILD.gn‎

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,20 @@ import("//flutter/testing/android/native_activity/native_activity.gni")
66
import("//flutter/vulkan/config.gni")
77
import("../../../tools/impeller.gni")
88

9+
source_set("mock_vulkan") {
10+
testonly = true
11+
12+
sources = [
13+
"test/mock_vulkan.cc",
14+
"test/mock_vulkan.h",
15+
]
16+
17+
deps = [
18+
":vulkan",
19+
"//flutter/fml",
20+
]
21+
}
22+
923
impeller_component("vulkan_unittests") {
1024
testonly = true
1125
sources = [
@@ -25,13 +39,12 @@ impeller_component("vulkan_unittests") {
2539
"resource_manager_vk_unittests.cc",
2640
"surface_context_vk_unittests.cc",
2741
"test/gpu_tracer_unittests.cc",
28-
"test/mock_vulkan.cc",
29-
"test/mock_vulkan.h",
3042
"test/mock_vulkan_unittests.cc",
3143
"test/sampler_library_vk_unittests.cc",
3244
"test/swapchain_unittests.cc",
3345
]
3446
deps = [
47+
":mock_vulkan",
3548
":vulkan",
3649
"../../../playground:playground_test",
3750
"//flutter/testing:testing_lib",
@@ -179,9 +192,13 @@ if (is_android) {
179192

180193
testonly = true
181194

182-
sources = [ "android/ahb_texture_source_vk_unittests.cc" ]
195+
sources = [
196+
"android/ahb_swapchain_vk_unittests.cc",
197+
"android/ahb_texture_source_vk_unittests.cc",
198+
]
183199

184200
deps = [
201+
":mock_vulkan",
185202
":unittests_fixtures",
186203
":vulkan",
187204
"//flutter/testing",
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
// Copyright 2013 The Flutter Authors. All rights reserved.
2+
// Use of this source code is governed by a BSD-style license that can be
3+
// found in the LICENSE file.
4+
5+
#include "gtest/gtest.h"
6+
7+
#include "impeller/renderer/backend/vulkan/swapchain/ahb/ahb_swapchain_vk.h"
8+
#include "impeller/renderer/backend/vulkan/test/mock_vulkan.h"
9+
#include "impeller/toolkit/android/surface_control.h"
10+
11+
namespace impeller::android::testing {
12+
13+
using impeller::testing::MockVulkanContextBuilder;
14+
15+
const std::vector<std::string> kAndroidDeviceExtensions = {
16+
"VK_KHR_swapchain",
17+
"VK_ANDROID_external_memory_android_hardware_buffer",
18+
"VK_KHR_sampler_ycbcr_conversion",
19+
"VK_KHR_external_memory",
20+
"VK_EXT_queue_family_foreign",
21+
"VK_KHR_dedicated_allocation",
22+
};
23+
24+
class FakeSurfaceControl : public SurfaceControl {
25+
public:
26+
bool IsValid() const override { return true; }
27+
28+
ASurfaceControl* GetHandle() const override { return nullptr; }
29+
30+
bool RemoveFromParent() const override { return true; }
31+
};
32+
33+
TEST(AndroidAHBSwapchainTest,
34+
AHBSwapchainNoFenceWaitAfterAcquireNextImageFailure) {
35+
bool wait_for_fences_called = false;
36+
auto const context =
37+
MockVulkanContextBuilder()
38+
.SetDeviceExtensions(kAndroidDeviceExtensions)
39+
.SetAcquireNextImageCallback(
40+
[](VkDevice, VkSwapchainKHR, uint64_t, VkSemaphore, VkFence,
41+
uint32_t*) -> VkResult { return VK_ERROR_SURFACE_LOST_KHR; })
42+
.SetWaitForFencesCallback([&](VkDevice, uint32_t, const VkFence*,
43+
VkBool32, uint64_t) -> VkResult {
44+
wait_for_fences_called = true;
45+
return VK_SUCCESS;
46+
})
47+
.Build();
48+
49+
auto ahb_swapchain = std::shared_ptr<AHBSwapchainVK>(new AHBSwapchainVK(
50+
context, std::make_shared<FakeSurfaceControl>(), {}, {100, 100}, false));
51+
52+
auto image = ahb_swapchain->AcquireNextDrawable();
53+
EXPECT_FALSE(image);
54+
55+
ahb_swapchain->AcquireNextDrawable();
56+
EXPECT_FALSE(wait_for_fences_called);
57+
}
58+
59+
} // namespace impeller::android::testing

‎engine/src/flutter/impeller/renderer/backend/vulkan/swapchain/ahb/ahb_swapchain_impl_vk.cc‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ static TextureDescriptor ToSwapchainTextureDescriptor(
2929
}
3030

3131
AHBFrameSynchronizerVK::AHBFrameSynchronizerVK(const vk::Device& device) {
32-
auto acquire_res = device.createFenceUnique(
33-
vk::FenceCreateInfo{vk::FenceCreateFlagBits::eSignaled});
32+
auto acquire_res = device.createFenceUnique({});
3433
if (acquire_res.result != vk::Result::eSuccess) {
3534
VALIDATION_LOG << "Could not create synchronizer.";
3635
return;
@@ -46,6 +45,9 @@ bool AHBFrameSynchronizerVK::IsValid() const {
4645
}
4746

4847
bool AHBFrameSynchronizerVK::WaitForFence(const vk::Device& device) {
48+
if (!acquire_fence_pending) {
49+
return true;
50+
}
4951
if (auto result = device.waitForFences(
5052
*acquire, // fence
5153
true, // wait all
@@ -55,6 +57,7 @@ bool AHBFrameSynchronizerVK::WaitForFence(const vk::Device& device) {
5557
VALIDATION_LOG << "Fence wait failed: " << vk::to_string(result);
5658
return false;
5759
}
60+
acquire_fence_pending = false;
5861
if (auto result = device.resetFences(*acquire);
5962
result != vk::Result::eSuccess) {
6063
VALIDATION_LOG << "Could not reset fence: " << vk::to_string(result);
@@ -266,6 +269,7 @@ AHBSwapchainImplVK::SubmitSignalForPresentReady(
266269
if (result != vk::Result::eSuccess) {
267270
return nullptr;
268271
}
272+
sync->acquire_fence_pending = true;
269273
return present_ready;
270274
}
271275

‎engine/src/flutter/impeller/renderer/backend/vulkan/swapchain/ahb/ahb_swapchain_impl_vk.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ static constexpr const size_t kMaxPendingPresents = 2u;
2727

2828
struct AHBFrameSynchronizerVK {
2929
vk::UniqueFence acquire;
30+
bool acquire_fence_pending = false;
3031
vk::UniqueSemaphore render_ready = {};
3132
std::shared_ptr<ExternalSemaphoreVK> present_ready;
3233
std::shared_ptr<CommandBuffer> final_cmd_buffer;

‎engine/src/flutter/impeller/renderer/backend/vulkan/swapchain/ahb/ahb_swapchain_vk.cc‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ bool AHBSwapchainVK::IsAvailableOnPlatform() {
1717
android::HardwareBuffer::IsAvailableOnPlatform();
1818
}
1919

20-
AHBSwapchainVK::AHBSwapchainVK(const std::shared_ptr<Context>& context,
21-
ANativeWindow* window,
22-
const CreateTransactionCB& cb,
23-
const ISize& size,
24-
bool enable_msaa)
20+
AHBSwapchainVK::AHBSwapchainVK(
21+
const std::shared_ptr<Context>& context,
22+
const std::shared_ptr<android::SurfaceControl>& surface_control,
23+
const CreateTransactionCB& cb,
24+
const ISize& size,
25+
bool enable_msaa)
2526
: context_(context),
26-
surface_control_(
27-
std::make_shared<android::SurfaceControl>(window, "ImpellerSurface")),
27+
surface_control_(surface_control),
2828
enable_msaa_(enable_msaa),
2929
cb_(cb) {
3030
UpdateSurfaceSize(size);

‎engine/src/flutter/impeller/renderer/backend/vulkan/swapchain/ahb/ahb_swapchain_vk.h‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@
1313

1414
namespace impeller {
1515

16+
namespace android::testing {
17+
FML_TEST_CLASS(AndroidAHBSwapchainTest,
18+
AHBSwapchainNoFenceWaitAfterAcquireNextImageFailure);
19+
}
20+
1621
using CreateTransactionCB = std::function<android::SurfaceTransaction()>;
1722

1823
//------------------------------------------------------------------------------
@@ -55,18 +60,21 @@ class AHBSwapchainVK final : public SwapchainVK {
5560

5661
private:
5762
friend class SwapchainVK;
63+
FML_FRIEND_TEST(android::testing::AndroidAHBSwapchainTest,
64+
AHBSwapchainNoFenceWaitAfterAcquireNextImageFailure);
5865

5966
std::weak_ptr<Context> context_;
6067
std::shared_ptr<android::SurfaceControl> surface_control_;
6168
const bool enable_msaa_;
6269
CreateTransactionCB cb_;
6370
std::shared_ptr<AHBSwapchainImplVK> impl_;
6471

65-
explicit AHBSwapchainVK(const std::shared_ptr<Context>& context,
66-
ANativeWindow* window,
67-
const CreateTransactionCB& cb,
68-
const ISize& size,
69-
bool enable_msaa);
72+
explicit AHBSwapchainVK(
73+
const std::shared_ptr<Context>& context,
74+
const std::shared_ptr<android::SurfaceControl>& surface_control,
75+
const CreateTransactionCB& cb,
76+
const ISize& size,
77+
bool enable_msaa);
7078
};
7179

7280
} // namespace impeller

‎engine/src/flutter/impeller/renderer/backend/vulkan/swapchain/swapchain_vk.cc‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,15 @@ std::shared_ptr<SwapchainVK> SwapchainVK::Create(
5050
AHBSwapchainVK::IsAvailableOnPlatform()) {
5151
CreateTransactionCB callback =
5252
android_get_device_api_level() >= 34 ? cb : CreateTransactionCB({});
53-
auto ahb_swapchain = std::shared_ptr<AHBSwapchainVK>(new AHBSwapchainVK(
54-
context, //
55-
window.GetHandle(), //
56-
callback, //
57-
window.GetSize(), //
58-
enable_msaa //
59-
));
53+
auto surface_control = std::shared_ptr(
54+
android::SurfaceControl::Create(window.GetHandle(), "ImpellerSurface"));
55+
auto ahb_swapchain =
56+
std::shared_ptr<AHBSwapchainVK>(new AHBSwapchainVK(context, //
57+
surface_control, //
58+
callback, //
59+
window.GetSize(), //
60+
enable_msaa //
61+
));
6062

6163
if (ahb_swapchain->IsValid()) {
6264
return ahb_swapchain;

‎engine/src/flutter/impeller/renderer/backend/vulkan/test/mock_vulkan.cc‎

Lines changed: 40 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,7 @@ class MockDevice final {
110110
struct MockVulkanState {
111111
std::vector<std::string> instance_extensions;
112112
std::vector<std::string> instance_layers;
113+
std::vector<std::string> device_extensions;
113114
std::function<void(VkPhysicalDevice physicalDevice,
114115
VkFormat format,
115116
VkFormatProperties* pFormatProperties)>
@@ -165,32 +166,46 @@ VkResult vkEnumerateInstanceExtensionProperties(
165166
VkExtensionProperties* pProperties) {
166167
if (!pProperties) {
167168
*pPropertyCount = GetMockVulkanState().instance_extensions.size();
169+
return VK_SUCCESS;
168170
} else {
169171
uint32_t count = 0;
172+
VkResult result = VK_SUCCESS;
170173
for (const std::string& ext : GetMockVulkanState().instance_extensions) {
171-
strncpy(pProperties[count].extensionName, ext.c_str(),
172-
sizeof(VkExtensionProperties::extensionName));
174+
if (count >= *pPropertyCount) {
175+
result = VK_INCOMPLETE;
176+
break;
177+
}
178+
snprintf(pProperties[count].extensionName,
179+
sizeof(pProperties[count].extensionName), "%s", ext.c_str());
173180
pProperties[count].specVersion = 0;
174181
count++;
175182
}
183+
*pPropertyCount = count;
184+
return result;
176185
}
177-
return VK_SUCCESS;
178186
}
179187

180188
VkResult vkEnumerateInstanceLayerProperties(uint32_t* pPropertyCount,
181189
VkLayerProperties* pProperties) {
182190
if (!pProperties) {
183191
*pPropertyCount = GetMockVulkanState().instance_layers.size();
192+
return VK_SUCCESS;
184193
} else {
185194
uint32_t count = 0;
186-
for (const std::string& layer : GetMockVulkanState().instance_layers) {
187-
strncpy(pProperties[count].layerName, layer.c_str(),
188-
sizeof(VkLayerProperties::layerName));
195+
VkResult result = VK_SUCCESS;
196+
for (const std::string& ext : GetMockVulkanState().instance_layers) {
197+
if (count >= *pPropertyCount) {
198+
result = VK_INCOMPLETE;
199+
break;
200+
}
201+
snprintf(pProperties[count].layerName,
202+
sizeof(pProperties[count].layerName), "%s", ext.c_str());
189203
pProperties[count].specVersion = 0;
190204
count++;
191205
}
206+
*pPropertyCount = count;
207+
return result;
192208
}
193-
return VK_SUCCESS;
194209
}
195210

196211
VkResult vkEnumeratePhysicalDevices(VkInstance instance,
@@ -246,12 +261,24 @@ VkResult vkEnumerateDeviceExtensionProperties(
246261
uint32_t* pPropertyCount,
247262
VkExtensionProperties* pProperties) {
248263
if (!pProperties) {
249-
*pPropertyCount = 1;
264+
*pPropertyCount = GetMockVulkanState().device_extensions.size();
265+
return VK_SUCCESS;
250266
} else {
251-
strcpy(pProperties[0].extensionName, "VK_KHR_swapchain");
252-
pProperties[0].specVersion = 0;
267+
uint32_t count = 0;
268+
VkResult result = VK_SUCCESS;
269+
for (const std::string& ext : GetMockVulkanState().device_extensions) {
270+
if (count >= *pPropertyCount) {
271+
result = VK_INCOMPLETE;
272+
break;
273+
}
274+
snprintf(pProperties[count].extensionName,
275+
sizeof(pProperties[count].extensionName), "%s", ext.c_str());
276+
pProperties[count].specVersion = 0;
277+
count++;
278+
}
279+
*pPropertyCount = count;
280+
return result;
253281
}
254-
return VK_SUCCESS;
255282
}
256283

257284
VkResult vkCreateDevice(VkPhysicalDevice physicalDevice,
@@ -1026,6 +1053,7 @@ PFN_vkVoidFunction GetMockVulkanProcAddress(VkInstance instance,
10261053

10271054
MockVulkanContextBuilder::MockVulkanContextBuilder()
10281055
: instance_extensions_({"VK_KHR_surface", "VK_MVK_macos_surface"}),
1056+
device_extensions_({"VK_KHR_swapchain"}),
10291057
format_properties_callback_([](VkPhysicalDevice physicalDevice,
10301058
VkFormat format,
10311059
VkFormatProperties* pFormatProperties) {
@@ -1054,6 +1082,7 @@ std::shared_ptr<ContextVK> MockVulkanContextBuilder::Build() {
10541082
g_mock_vulkan_state.reset(new MockVulkanState());
10551083
g_mock_vulkan_state->instance_extensions = instance_extensions_;
10561084
g_mock_vulkan_state->instance_layers = instance_layers_;
1085+
g_mock_vulkan_state->device_extensions = device_extensions_;
10571086
g_mock_vulkan_state->format_properties_callback = format_properties_callback_;
10581087
g_mock_vulkan_state->physical_device_properties_callback =
10591088
physical_properties_callback_;

‎engine/src/flutter/impeller/renderer/backend/vulkan/test/mock_vulkan.h‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,12 @@ class MockVulkanContextBuilder {
8989
return *this;
9090
}
9191

92+
MockVulkanContextBuilder& SetDeviceExtensions(
93+
const std::vector<std::string>& device_extensions) {
94+
device_extensions_ = device_extensions;
95+
return *this;
96+
}
97+
9298
/// Set the behavior of vkGetPhysicalDeviceFormatProperties, which needs to
9399
/// respond differently for different formats.
94100
MockVulkanContextBuilder& SetPhysicalDeviceFormatPropertiesCallback(
@@ -132,6 +138,7 @@ class MockVulkanContextBuilder {
132138
std::function<void(ContextVK::Settings&)> settings_callback_;
133139
std::vector<std::string> instance_extensions_;
134140
std::vector<std::string> instance_layers_;
141+
std::vector<std::string> device_extensions_;
135142
std::optional<ContextVK::EmbedderData> embedder_data_;
136143
std::function<void(VkPhysicalDevice physicalDevice,
137144
VkFormat format,

‎engine/src/flutter/impeller/toolkit/android/BUILD.gn‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ impeller_component("android") {
2121
"proc_table.h",
2222
"surface_control.cc",
2323
"surface_control.h",
24+
"surface_control_impl.cc",
25+
"surface_control_impl.h",
2426
"surface_transaction.cc",
2527
"surface_transaction.h",
2628
"surface_transaction_stats.cc",

0 commit comments

Comments
 (0)