[Windows] GDI resource leaks when using the software renderer code path

[sevenstars]

GDI resource (Device Context) leaks when using the software renderer code path.

This only happens when the app is using software rasterization, i.e., if the embedder explicitly specifies FlutterRendererType::kSoftware or AngleSurfaceManager::Create() somehow fails.

The leak happens in every frame, so after a while, number of leaks will soon reach the default per-process limit of GDI handles and then the app UI will not be responsive.

[danagbemava-nc]

Hi @sevenstars, would it be possible for you to provide a complete minimal reproducible code sample as well as steps to reproduce?

Please also provide the output of flutter doctor -v.

Thank you

[sevenstars]

Hi @sevenstars, would it be possible for you to provide a complete minimal reproducible code sample as well as steps to reproduce?

Please also provide the output of flutter doctor -v.

Thank you

The leak can be reproduced when the app is using software rasterization on Windows, i.e., in one of scenarios as follows:

1. The embedder explicitly specifies kSoftware as the FlutterRendererType when calling embedder API FlutterEngineRun(), or
2. AngleSurfaceManager::Create() somehow fails

I've created a PR to fix this: flutter/engine#34574

[danagbemava-nc]

Hi @sevenstars, I'm not familiar with the scenarios you described above.

Can you provide a small sample app that has any of the scenarios described above?

[sevenstars]

The leak can be reproduced with any flutter app using the software fallback path. The flutter engine will try to use hardware accelerated rendering if possible, and I found AngleSurfaceManager::Create() somehow fails on some Windows 7 machines, so in this case the flutter engine will use the software fallback path.

You can reproduce the leak on any Windows 10 machine, using the following steps:

1. Use the DirectX Control Panel (DXCpl.exe) to apply Direct3D debug settings for the flutter app.
2. Run the image_list example app.
3. Use the GDIView tool to see the resource leaks.

The result:
After running the app for a few minutes, you will see the number of leaks reaches 10000, and the app will stop updating.

Use the DirectX Control Panel (DXCpl.exe) to apply Direct3D debug settings for the flutter app

Run the image_list example app

Use the GDIView tool to see the resource leaks

cc @danagbemava-nc

[danagbemava-nc]

Thanks for the repro info. I am unable to repro this at the moment so I will label for further insight and update when I am able to repro.

Sample for testing https://github.com/flutter/flutter/tree/master/examples/image_list

[loic-sharma]

I was able to repro this by forcing the software renderer config on my local engine:

diff --git a/shell/platform/windows/flutter_windows_engine.cc b/shell/platform/windows/flutter_windows_engine.cc
index ceb4634d43..c0065a6a78 100644
--- a/shell/platform/windows/flutter_windows_engine.cc
+++ b/shell/platform/windows/flutter_windows_engine.cc
@@ -305,9 +305,12 @@ bool FlutterWindowsEngine::RunWithEntrypoint(const char* entrypoint) {
     args.custom_dart_entrypoint = entrypoint;
   }
 
-  FlutterRendererConfig renderer_config = surface_manager_
-                                              ? GetOpenGLRendererConfig()
-                                              : GetSoftwareRendererConfig();
+  // FlutterRendererConfig renderer_config = surface_manager_
+  //                                             ? GetOpenGLRendererConfig()
+  //                                             : GetSoftwareRendererConfig();
+
+
+  FlutterRendererConfig renderer_config = GetSoftwareRendererConfig();
 
   auto result = embedder_api_.Run(FLUTTER_ENGINE_VERSION, &renderer_config,
                                   &args, this, &engine_);

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new bug, including the output of flutter doctor -v and a minimal reproduction of the issue.