Add `--enable-multi-window` option and refactor runner code #12

hbatagelo · 2024-12-11T14:59:33Z

This pull request is the framework counterpart of canonical/flutter-engine#1. It introduces the --enable-multi-window command-line option to flutter tools and updates the runner code of the reference application to align with the refactored Windows embedder.

Updated Steps for Running the Reference App

Prerequisites

Build a custom engine using the refactored embedder
(The following assumes the engine is built in debug mode)

Run with `flutter run --enable-multi-window`

cd <path_to_flutter>\examples\multi_window_ref_app
flutter run --enable-multi-window --debug --local-engine-src-path <path_to_custom_engine> --local-engine host_debug_unopt --local-engine-host host_debug_unopt lib/main.dart

Build and run manually

Build the application:

cd <path_to_flutter>\examples\multi_window_ref_app
flutter build windows --debug --local-engine-src-path <path_to_custom_engine> --local-engine host_debug_unopt --local-engine-host host_debug_unopt lib/main.dart

Set environment variables and run the executable:

set FLUTTER_ENGINE_SWITCHES=1
set FLUTTER_ENGINE_SWITCH_1=enable-multi-window=true
.\build\windows\x64\runner\Debug\multi_window_ref_app.exe

…code

mattkae

Working well for me!

robert-ancell

LGTM

The crash indicates that FlutterJNI is returning a nullptr SurfaceControl.Transaction. That likely indicates that we're trying to rasterize a frame before the platform view controller is setup. Potentially a startup race? At any rate, if the PVC is null that means there is no platform views - so it should be safe to create a tx on the fly. Interestingly I cannot repro this locally even on the same device. ``` [2025-02-11 21:50:37.462356] [STDOUT] stdout: [ +173 ms] *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** [2025-02-11 21:50:37.462539] [STDOUT] stdout: [ ] Build fingerprint: 'google/cheetah/cheetah:13/TQ3A.230901.001/10750268:user/release-keys' [2025-02-11 21:50:37.462564] [STDOUT] stdout: [ ] Revision: 'MP1.0' [2025-02-11 21:50:37.463914] [STDOUT] stdout: [ +1 ms] ABI: 'arm64' [2025-02-11 21:50:37.463946] [STDOUT] stdout: [ ] Timestamp: 2025-02-11 21:57:42.183302140-0800 [2025-02-11 21:50:37.463959] [STDOUT] stdout: [ ] Process uptime: 3s [2025-02-11 21:50:37.464054] [STDOUT] stdout: [ ] Cmdline: dev.benchmarks.platform_views_layout [2025-02-11 21:50:37.464174] [STDOUT] stdout: [ ] pid: 15185, tid: 15246, name: 1.raster >>> dev.benchmarks.platform_views_layout <<< [2025-02-11 21:50:37.464354] [STDOUT] stdout: [ ] uid: 10250 [2025-02-11 21:50:37.464398] [STDOUT] stdout: [ ] tagged_addr_ctrl: 0000000000000001 (PR_TAGGED_ADDR_ENABLE) [2025-02-11 21:50:37.464440] [STDOUT] stdout: [ ] signal 11 (SIGSEGV), code 1 (SEGV_MAPERR), fault addr 0x0000000000000000 [2025-02-11 21:50:37.464602] [STDOUT] stdout: [ ] Cause: null pointer dereference [2025-02-11 21:50:37.464651] [STDOUT] stdout: [ ] x0 b400007b82ff2e70 x1 000000000000002d x2 b400007c3309f370 x3 0000007abbcc6a23 [2025-02-11 21:50:37.464745] [STDOUT] stdout: [ ] x4 0000007a30d286b0 x5 0000007a4f6dd47b x6 0000000000000000 x7 61686b4b11ff3a78 [2025-02-11 21:50:37.464831] [STDOUT] stdout: [ ] x8 0000000000000000 x9 1417c2bd490e1f78 x10 0000000000000010 x11 000000000000009c [2025-02-11 21:50:37.464933] [STDOUT] stdout: [ ] x12 0000000000000adb x13 b400007ba2fe9510 x14 0000000000000e6b x15 b400007ba2fe9510 [2025-02-11 21:50:37.465012] [STDOUT] stdout: [ ] x16 0000000000000001 x17 0000000000000067 x18 0000007a2f996000 x19 b400007b82ff2e70 [2025-02-11 21:50:37.465082] [STDOUT] stdout: [ ] x20 000000000000002d x21 b400007ae3064b60 x22 b400007af30d0fa8 x23 0000000000000001 [2025-02-11 21:50:37.465155] [STDOUT] stdout: [ ] x24 0000007a30d2a000 x25 b400007b73028fb0 x26 0000007a3a22da20 x27 000000003b9bf6c8 [2025-02-11 21:50:37.465235] [STDOUT] stdout: [ ] x28 b400007af30d0fa8 x29 b400007ad3022cd0 [2025-02-11 21:50:37.465318] [STDOUT] stdout: [ ] lr 0000007a3a8c7918 sp 0000007a30d28940 pc 0000000000000000 pst 0000000040001000 [2025-02-11 21:50:37.465401] [STDOUT] stdout: [ ] backtrace: [2025-02-11 21:50:37.465491] [STDOUT] stdout: [ ] #00 pc 0000000000000000 <unknown> [2025-02-11 21:50:37.465596] [STDOUT] stdout: [ ] #1 pc 000000000088b914 /data/app/~~u9nRjz4bI1GoKFecw6gtbg==/dev.benchmarks.platform_views_layout-RoPBoOldhc38L7sINb2Vgg==/lib/arm64/libflutter.so (flutter::PlatformViewAndroidJNIImpl::createTransaction()+104) (BuildId: 8fab16f9507483301ef418db2c91ed06689696b1) [2025-02-11 21:50:37.465688] [STDOUT] stdout: [ ] #2 pc 000000000087f738 /data/app/~~u9nRjz4bI1GoKFecw6gtbg==/dev.benchmarks.platform_views_layout-RoPBoOldhc38L7sINb2Vgg==/lib/arm64/libflutter.so (std::_fl::__function::__func<flutter::AndroidSurfaceVKImpeller::SetNativeWindow(fml::RefPtr<flutter::AndroidNativeWindow>, std::_fl::shared_ptr<flutter::PlatformViewAndroidJNI> const&)::$_0, std::_fl::allocator<flutter::AndroidSurfaceVKImpeller::SetNativeWindow(fml::RefPtr<flutter::AndroidNativeWindow>, std::_fl::shared_ptr<flutter::PlatformViewAndroidJNI> const&)::$_0>, impeller::android::SurfaceTransaction ()>::operator()()+16) (BuildId: 8fab16f9507483301ef418db2c91ed06689696b1) [2025-02-11 21:50:37.465785] [STDOUT] stdout: [ ] #3 pc 0000000000bdbf1c /data/app/~~u9nRjz4bI1GoKFecw6gtbg==/dev.benchmarks.platform_views_layout-RoPBoOldhc38L7sINb2Vgg==/lib/arm64/libflutter.so (std::_fl::__function::__func<impeller::AHBSwapchainImplVK::AcquireNextDrawable()::$_0, std::_fl::allocator<impeller::AHBSwapchainImplVK::AcquireNextDrawable()::$_0>, bool ()>::operator()()+1716) (BuildId: 8fab16f9507483301ef418db2c91ed06689696b1) [2025-02-11 21:50:37.465874] [STDOUT] stdout: [ ] #4 pc 0000000000b1d180 /data/app/~~u9nRjz4bI1GoKFecw6gtbg==/dev.benchmarks.platform_views_layout-RoPBoOldhc38L7sINb2Vgg==/lib/arm64/libflutter.so (flutter::SurfaceFrame::Submit()+148) (BuildId: 8fab16f9507483301ef418db2c91ed06689696b1) [2025-02-11 21:50:37.465989] [STDOUT] stdout: [ ] #5 pc 0000000000beb2b4 /data/app/~~u9nRjz4bI1GoKFecw6gtbg==/dev.benchmarks.platform_views_layout-RoPBoOldhc38L7sINb2Vgg==/lib/arm64/libflutter.so (flutter::Rasterizer::DrawToSurfacesUnsafe(flutter::FrameTimingsRecorder&, std::_fl::vector<std::_fl::unique_ptr<flutter::LayerTreeTask, std::_fl::default_delete<flutter::LayerTreeTask> >, std::_fl::allocator<std::_fl::unique_ptr<flutter::LayerTreeTask, std::_fl::default_delete<flutter::LayerTreeTask> > > >)+1284) (BuildId: 8fab16f9507483301ef418db2c91ed06689696b1) [2025-02-11 21:50:37.466400] [STDOUT] stdout: [ ] #6 pc 0000000000beac58 /data/app/~~u9nRjz4bI1GoKFecw6gtbg==/dev.benchmarks.platform_views_layout-RoPBoOldhc38L7sINb2Vgg==/lib/arm64/libflutter.so (flutter::Rasterizer::DrawToSurfaces(flutter::FrameTimingsRecorder&, std::_fl::vector<std::_fl::unique_ptr<flutter::LayerTreeTask, std::_fl::default_delete<flutter::LayerTreeTask> >, std::_fl::allocator<std::_fl::unique_ptr<flutter::LayerTreeTask, std::_fl::default_delete<flutter::LayerTreeTask> > > >)+112) (BuildId: 8fab16f9507483301ef418db2c91ed06689696b1) [2025-02-11 21:50:37.466444] [STDOUT] stdout: [ ] #7 pc 0000000000bec144 /data/app/~~u9nRjz4bI1GoKFecw6gtbg==/dev.benchmarks.platform_views_layout-RoPBoOldhc38L7sINb2Vgg==/lib/arm64/libflutter.so (std::_fl::__function::__func<flutter::Rasterizer::Draw(std::_fl::shared_ptr<flutter::Pipeline<flutter::FrameItem> > const&)::$_0, std::_fl::allocator<flutter::Rasterizer::Draw(std::_fl::shared_ptr<flutter::Pipeline<flutter::FrameItem> > const&)::$_0>, void (std::_fl::unique_ptr<flutter::FrameItem, std::_fl::default_delete<flutter::FrameItem> >)>::operator()(std::_fl::unique_ptr<flutter::FrameItem, std::_fl::default_delete<flutter::FrameItem> >&&)+192) (BuildId: 8fab16f9507483301ef418db2c91ed06689696b1) [2025-02-11 21:50:37.466468] [STDOUT] stdout: [ ] #8 pc 0000000000bebc48 /data/app/~~u9nRjz4bI1GoKFecw6gtbg==/dev.benchmarks.platform_views_layout-RoPBoOldhc38L7sINb2Vgg==/lib/arm64/libflutter.so (flutter::Rasterizer::Draw(std::_fl::shared_ptr<flutter::Pipeline<flutter::FrameItem> > const&)+360) (BuildId: 8fab16f9507483301ef418db2c91ed06689696b1) [2025-02-11 21:50:37.466521] [STDOUT] stdout: [ ] #9 pc 0000000000bf9f7c /data/app/~~u9nRjz4bI1GoKFecw6gtbg==/dev.benchmarks.platform_views_layout-RoPBoOldhc38L7sINb2Vgg==/lib/arm64/libflutter.so (std::_fl::__function::__func<fml::internal::CopyableLambda<flutter::Shell::OnAnimatorDraw(std::_fl::shared_ptr<flutter::Pipeline<flutter::FrameItem> >)::$_0>, std::_fl::allocator<fml::internal::CopyableLambda<flutter::Shell::OnAnimatorDraw(std::_fl::shared_ptr<flutter::Pipeline<flutter::FrameItem> >)::$_0> >, void ()>::operator()()+84) (BuildId: 8fab16f9507483301ef418db2c91ed06689696b1) [2025-02-11 21:50:37.466543] [STDOUT] stdout: [ ] #10 pc 00000000008a09ec /data/app/~~u9nRjz4bI1GoKFecw6gtbg==/dev.benchmarks.platform_views_layout-RoPBoOldhc38L7sINb2Vgg==/lib/arm64/libflutter.so (fml::MessageLoopImpl::RunExpiredTasksNow()+728) (BuildId: 8fab16f9507483301ef418db2c91ed06689696b1) [2025-02-11 21:50:37.466667] [STDOUT] stdout: [ ] #11 pc 00000000008a4600 /data/app/~~u9nRjz4bI1GoKFecw6gtbg==/dev.benchmarks.platform_views_layout-RoPBoOldhc38L7sINb2Vgg==/lib/arm64/libflutter.so (fml::MessageLoopAndroid::MessageLoopAndroid()::$_0::__invoke(int, int, void*)+84) (BuildId: 8fab16f9507483301ef418db2c91ed06689696b1) [2025-02-11 21:50:37.466746] [STDOUT] stdout: [ ] #12 pc 0000000000011178 /system/lib64/libutils.so (android::Looper::pollOnce(int, int*, int*, void**)+808) (BuildId: 0b4a793fa8045c04066d988c68bac8bb) [2025-02-11 21:50:37.466784] [STDOUT] stdout: [ ] #13 pc 00000000000185e4 /system/lib64/libandroid.so (ALooper_pollOnce+100) (BuildId: 682dab490c18361d5d6527bcdd86cdfa) [2025-02-11 21:50:37.466865] [STDOUT] stdout: [ ] #14 pc 00000000008a470c /data/app/~~u9nRjz4bI1GoKFecw6gtbg==/dev.benchmarks.platform_views_layout-RoPBoOldhc38L7sINb2Vgg==/lib/arm64/libflutter.so (fml::MessageLoopAndroid::Run()+28) (BuildId: 8fab16f9507483301ef418db2c91ed06689696b1) [2025-02-11 21:50:37.466903] [STDOUT] stdout: [ ] #15 pc 00000000008a283c /data/app/~~u9nRjz4bI1GoKFecw6gtbg==/dev.benchmarks.platform_views_layout-RoPBoOldhc38L7sINb2Vgg==/lib/arm64/libflutter.so (std::_fl::__function::__func<fml::Thread::Thread(std::_fl::function<void (fml::Thread::ThreadConfig const&)> const&, fml::Thread::ThreadConfig const&)::$_0, std::_fl::allocator<fml::Thread::Thread(std::_fl::function<void (fml::Thread::ThreadConfig const&)> const&, fml::Thread::ThreadConfig const&)::$_0>, void ()>::operator()()+116) (BuildId: 8fab16f9507483301ef418db2c91ed06689696b1) [2025-02-11 21:50:37.466943] [STDOUT] stdout: [ ] #16 pc 00000000008a2670 /data/app/~~u9nRjz4bI1GoKFecw6gtbg==/dev.benchmarks.platform_views_layout-RoPBoOldhc38L7sINb2Vgg==/lib/arm64/libflutter.so (fml::ThreadHandle::ThreadHandle(std::_fl::function<void ()>&&)::$_0::__invoke(void*)+8) (BuildId: 8fab16f9507483301ef418db2c91ed06689696b1) [2025-02-11 21:50:37.467002] [STDOUT] stdout: [ ] #17 pc 00000000000c226c /apex/com.android.runtime/lib64/bionic/libc.so (__pthread_start(void*)+204) (BuildId: dc4001c2ef2dfc23467040797a96840c) [2025-02-11 21:50:37.467058] [STDOUT] stdout: [ ] #18 pc 0000000000054a30 /apex/com.android.runtime/lib64/bionic/libc.so (__start_thread+64) (BuildId: dc4001c2ef2dfc23467040797a96840c) [2025-02-11 21:50:37.525275] [STDOUT] stdout: [ +57 ms] 00:00 �[32m+0�[0m�[31m -1�[0m: scrolling performance test (setUpAll) �[1m�[31m[E]�[0m�[0m ```

Fixes error found in rolling to google. ``` [☠] Android toolchain - develop for Android devices (the doctor check crashed) ✗ Due to an error, the doctor check did not complete. If the error message below is not helpful, please let us know about this issue at https://github.com/flutter/flutter/issues. ✗ type 'Null' is not a subtype of type 'String' of 'executable' • #0 LocalProcessManager.canRun (package:process/src/interface/local_process_manager.dart:124) #1 getEmulatorVersion (package:flutter_tools/src/android/android_workflow.dart:64) #2 AndroidValidator.validateImpl (package:flutter_tools/src/android/android_workflow.dart:200) #3 DoctorValidator.validate (package:flutter_tools/src/doctor_validator.dart:58) #4 Doctor.startValidatorTasks.<anonymous closure> (package:flutter_tools/src/doctor.dart:244) #5 asyncGuard.<anonymous closure> (package:flutter_tools/src/base/async_guard.dart:109) #6 _rootRun (dart:async/zone.dart:1525) #7 _CustomZone.run (dart:async/zone.dart:1422) #8 _runZoned (dart:async/zone.dart:2033) #9 runZonedGuarded (dart:async/zone.dart:2019) #10 runZoned (dart:async/zone.dart:1952) #11 asyncGuard (package:flutter_tools/src/base/async_guard.dart:106) #12 Doctor.startValidatorTasks (package:flutter_tools/src/doctor.dart:234) #13 Doctor.diagnose (package:flutter_tools/src/doctor.dart:372) #14 DoctorCommand.runCommand (package:flutter_tools/src/commands/doctor.dart:59) #15 FlutterCommand.verifyThenRunCommand (package:flutter_tools/src/runner/flutter_command.dart:1897) <asynchronous suspension> #16 FlutterCommand.run.<anonymous closure> (package:flutter_tools/src/runner/flutter_command.dart:1551) <asynchronous suspension> #17 AppContext.run.<anonymous closure> (package:flutter_tools/src/base/context.dart:154) <asynchronous suspension> #18 CommandRunner.runCommand (package:args/command_runner.dart:212) <asynchronous suspension> #19 FlutterCommandRunner.runCommand.<anonymous closure> (package:flutter_tools/src/runner/flutter_command_runner.dart:501) <asynchronous suspension> #20 AppContext.run.<anonymous closure> (package:flutter_tools/src/base/context.dart:154) <asynchronous suspension> #21 FlutterCommandRunner.runCommand (package:flutter_tools/src/runner/flutter_command_runner.dart:438) <asynchronous suspension> #22 run.<anonymous closure>.<anonymous closure> (package:flutter_tools/runner.dart:98) <asynchronous suspension> #23 AppContext.run.<anonymous closure> (package:flutter_tools/src/base/context.dart:154) <asynchronous suspension> #24 AppContext.run.<anonymous closure> (package:flutter_tools/src/base/context.dart:154) <asynchronous suspension> #25 run (package:mobile.flutter.cli/flutter_tools.dart:106) <asynchronous suspension> #26 main (google3:///mobile/flutter/cli/bin/cli_usage_aot.dart:4) ``` ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord].  [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md

…t_size feature: the initial size of a Window is now scaled to the initial size of its content

Add command-line option for multi-window support and refactor runner …

0312d1e

…code

hbatagelo requested review from mattkae and robert-ancell December 11, 2024 14:59

hbatagelo mentioned this pull request Dec 11, 2024

Refactor multi-window support canonical/flutter-engine#1

Merged

8 tasks

mattkae approved these changes Dec 11, 2024

View reviewed changes

robert-ancell approved these changes Dec 11, 2024

View reviewed changes

mattkae merged commit 8dead54 into foundation Dec 16, 2024
1 check passed

mattkae deleted the add-command-line-option branch December 16, 2024 14:43

mattkae pushed a commit that referenced this pull request Jun 5, 2025

Merge pull request #12 from canonical/feature/windows_scaled_to_widge…

5fdcf85

…t_size feature: the initial size of a Window is now scaled to the initial size of its content

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add `--enable-multi-window` option and refactor runner code #12

Add `--enable-multi-window` option and refactor runner code #12

Uh oh!

hbatagelo commented Dec 11, 2024

Uh oh!

mattkae left a comment

Uh oh!

robert-ancell left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Add --enable-multi-window option and refactor runner code #12

Add --enable-multi-window option and refactor runner code #12

Uh oh!

Conversation

hbatagelo commented Dec 11, 2024

Updated Steps for Running the Reference App

Prerequisites

Run with flutter run --enable-multi-window

Build and run manually

Uh oh!

mattkae left a comment

Choose a reason for hiding this comment

Uh oh!

robert-ancell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Add `--enable-multi-window` option and refactor runner code #12

Add `--enable-multi-window` option and refactor runner code #12

Run with `flutter run --enable-multi-window`