| // Copyright 2013 The Flutter Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #include "flutter/runtime/dart_isolate.h" |
| |
| #include <cstdlib> |
| #include <tuple> |
| |
| #include "flutter/fml/paths.h" |
| #include "flutter/fml/posix_wrappers.h" |
| #include "flutter/fml/trace_event.h" |
| #include "flutter/lib/io/dart_io.h" |
| #include "flutter/lib/ui/dart_runtime_hooks.h" |
| #include "flutter/lib/ui/dart_ui.h" |
| #include "flutter/runtime/dart_isolate_group_data.h" |
| #include "flutter/runtime/dart_service_isolate.h" |
| #include "flutter/runtime/dart_vm.h" |
| #include "flutter/runtime/dart_vm_lifecycle.h" |
| #include "flutter/runtime/isolate_configuration.h" |
| #include "fml/message_loop_task_queues.h" |
| #include "fml/task_source.h" |
| #include "fml/time/time_point.h" |
| #include "third_party/dart/runtime/include/dart_api.h" |
| #include "third_party/dart/runtime/include/dart_tools_api.h" |
| #include "third_party/tonic/converter/dart_converter.h" |
| #include "third_party/tonic/dart_class_library.h" |
| #include "third_party/tonic/dart_class_provider.h" |
| #include "third_party/tonic/dart_message_handler.h" |
| #include "third_party/tonic/dart_state.h" |
| #include "third_party/tonic/file_loader/file_loader.h" |
| #include "third_party/tonic/logging/dart_invoke.h" |
| #include "third_party/tonic/scopes/dart_api_scope.h" |
| #include "third_party/tonic/scopes/dart_isolate_scope.h" |
| |
| namespace flutter { |
| |
| namespace { |
| |
| constexpr std::string_view kFileUriPrefix = "file://"; |
| |
| class DartErrorString { |
| public: |
| DartErrorString() : str_(nullptr) {} |
| ~DartErrorString() { |
| if (str_) { |
| ::free(str_); |
| } |
| } |
| char** error() { return &str_; } |
| const char* str() const { return str_; } |
| explicit operator bool() const { return str_ != nullptr; } |
| |
| private: |
| FML_DISALLOW_COPY_AND_ASSIGN(DartErrorString); |
| char* str_; |
| }; |
| |
| } // anonymous namespace |
| |
| DartIsolate::Flags::Flags() : Flags(nullptr) {} |
| |
| DartIsolate::Flags::Flags(const Dart_IsolateFlags* flags) { |
| if (flags) { |
| flags_ = *flags; |
| } else { |
| ::Dart_IsolateFlagsInitialize(&flags_); |
| } |
| } |
| |
| DartIsolate::Flags::~Flags() = default; |
| |
| void DartIsolate::Flags::SetNullSafetyEnabled(bool enabled) { |
| flags_.null_safety = enabled; |
| } |
| |
| Dart_IsolateFlags DartIsolate::Flags::Get() const { |
| return flags_; |
| } |
| |
| std::weak_ptr<DartIsolate> DartIsolate::SpawnIsolate( |
| const Settings& settings, |
| std::unique_ptr<PlatformConfiguration> platform_configuration, |
| fml::WeakPtr<SnapshotDelegate> snapshot_delegate, |
| std::string advisory_script_uri, |
| std::string advisory_script_entrypoint, |
| Flags flags, |
| const fml::closure& isolate_create_callback, |
| const fml::closure& isolate_shutdown_callback, |
| std::optional<std::string> dart_entrypoint, |
| std::optional<std::string> dart_entrypoint_library, |
| std::unique_ptr<IsolateConfiguration> isolate_configration) const { |
| return CreateRunningRootIsolate( |
| settings, // |
| GetIsolateGroupData().GetIsolateSnapshot(), // |
| std::move(platform_configuration), // |
| flags, // |
| isolate_create_callback, // |
| isolate_shutdown_callback, // |
| dart_entrypoint, // |
| dart_entrypoint_library, // |
| std::move(isolate_configration), // |
| UIDartState::Context{GetTaskRunners(), // |
| snapshot_delegate, // |
| GetIOManager(), // |
| GetSkiaUnrefQueue(), // |
| GetImageDecoder(), // |
| GetImageGeneratorRegistry(), // |
| advisory_script_uri, // |
| advisory_script_entrypoint, // |
| GetVolatilePathTracker()}, // |
| this // |
| ); |
| } |
| |
| std::weak_ptr<DartIsolate> DartIsolate::CreateRunningRootIsolate( |
| const Settings& settings, |
| fml::RefPtr<const DartSnapshot> isolate_snapshot, |
| std::unique_ptr<PlatformConfiguration> platform_configuration, |
| Flags isolate_flags, |
| const fml::closure& isolate_create_callback, |
| const fml::closure& isolate_shutdown_callback, |
| std::optional<std::string> dart_entrypoint, |
| std::optional<std::string> dart_entrypoint_library, |
| std::unique_ptr<IsolateConfiguration> isolate_configration, |
| const UIDartState::Context& context, |
| const DartIsolate* spawning_isolate) { |
| if (!isolate_snapshot) { |
| FML_LOG(ERROR) << "Invalid isolate snapshot."; |
| return {}; |
| } |
| |
| if (!isolate_configration) { |
| FML_LOG(ERROR) << "Invalid isolate configuration."; |
| return {}; |
| } |
| |
| isolate_flags.SetNullSafetyEnabled( |
| isolate_configration->IsNullSafetyEnabled(*isolate_snapshot)); |
| |
| auto isolate = CreateRootIsolate(settings, // |
| isolate_snapshot, // |
| std::move(platform_configuration), // |
| isolate_flags, // |
| isolate_create_callback, // |
| isolate_shutdown_callback, // |
| context, // |
| spawning_isolate // |
| ) |
| .lock(); |
| |
| if (!isolate) { |
| FML_LOG(ERROR) << "Could not create root isolate."; |
| return {}; |
| } |
| |
| fml::ScopedCleanupClosure shutdown_on_error([isolate]() { |
| if (!isolate->Shutdown()) { |
| FML_DLOG(ERROR) << "Could not shutdown transient isolate."; |
| } |
| }); |
| |
| if (isolate->GetPhase() != DartIsolate::Phase::LibrariesSetup) { |
| FML_LOG(ERROR) << "Root isolate was created in an incorrect phase: " |
| << static_cast<int>(isolate->GetPhase()); |
| return {}; |
| } |
| |
| if (!isolate_configration->PrepareIsolate(*isolate.get())) { |
| FML_LOG(ERROR) << "Could not prepare isolate."; |
| return {}; |
| } |
| |
| if (isolate->GetPhase() != DartIsolate::Phase::Ready) { |
| FML_LOG(ERROR) << "Root isolate not in the ready phase for Dart entrypoint " |
| "invocation."; |
| return {}; |
| } |
| |
| if (settings.root_isolate_create_callback) { |
| // Isolate callbacks always occur in isolate scope and before user code has |
| // had a chance to run. |
| tonic::DartState::Scope scope(isolate.get()); |
| settings.root_isolate_create_callback(*isolate.get()); |
| } |
| |
| if (!isolate->RunFromLibrary(dart_entrypoint_library, // |
| dart_entrypoint, // |
| settings.dart_entrypoint_args // |
| )) { |
| FML_LOG(ERROR) << "Could not run the run main Dart entrypoint."; |
| return {}; |
| } |
| |
| if (settings.root_isolate_shutdown_callback) { |
| isolate->AddIsolateShutdownCallback( |
| settings.root_isolate_shutdown_callback); |
| } |
| |
| shutdown_on_error.Release(); |
| |
| return isolate; |
| } |
| |
| void DartIsolate::SpawnIsolateShutdownCallback( |
| std::shared_ptr<DartIsolateGroupData>* isolate_group_data, |
| std::shared_ptr<DartIsolate>* isolate_data) { |
| DartIsolate::DartIsolateShutdownCallback(isolate_group_data, isolate_data); |
| } |
| |
| std::weak_ptr<DartIsolate> DartIsolate::CreateRootIsolate( |
| const Settings& settings, |
| fml::RefPtr<const DartSnapshot> isolate_snapshot, |
| std::unique_ptr<PlatformConfiguration> platform_configuration, |
| Flags flags, |
| const fml::closure& isolate_create_callback, |
| const fml::closure& isolate_shutdown_callback, |
| const UIDartState::Context& context, |
| const DartIsolate* spawning_isolate) { |
| TRACE_EVENT0("flutter", "DartIsolate::CreateRootIsolate"); |
| |
| // The child isolate preparer is null but will be set when the isolate is |
| // being prepared to run. |
| auto isolate_group_data = |
| std::make_unique<std::shared_ptr<DartIsolateGroupData>>( |
| std::shared_ptr<DartIsolateGroupData>(new DartIsolateGroupData( |
| settings, // settings |
| std::move(isolate_snapshot), // isolate snapshot |
| context.advisory_script_uri, // advisory URI |
| context.advisory_script_entrypoint, // advisory entrypoint |
| nullptr, // child isolate preparer |
| isolate_create_callback, // isolate create callback |
| isolate_shutdown_callback // isolate shutdown callback |
| ))); |
| |
| auto isolate_data = std::make_unique<std::shared_ptr<DartIsolate>>( |
| std::shared_ptr<DartIsolate>(new DartIsolate( |
| settings, // settings |
| true, // is_root_isolate |
| std::move(context) // context |
| ))); |
| |
| DartErrorString error; |
| Dart_Isolate vm_isolate = nullptr; |
| auto isolate_flags = flags.Get(); |
| |
| IsolateMaker isolate_maker; |
| // TODO(74520): Remove IsRunningPrecompiledCode conditional once isolate |
| // groups are supported by JIT. |
| if (spawning_isolate && DartVM::IsRunningPrecompiledCode()) { |
| isolate_maker = [spawning_isolate]( |
| std::shared_ptr<DartIsolateGroupData>* |
| isolate_group_data, |
| std::shared_ptr<DartIsolate>* isolate_data, |
| Dart_IsolateFlags* flags, char** error) { |
| return Dart_CreateIsolateInGroup( |
| /*group_member=*/spawning_isolate->isolate(), |
| /*name=*/(*isolate_group_data)->GetAdvisoryScriptEntrypoint().c_str(), |
| /*shutdown_callback=*/ |
| reinterpret_cast<Dart_IsolateShutdownCallback>( |
| DartIsolate::SpawnIsolateShutdownCallback), |
| /*cleanup_callback=*/ |
| reinterpret_cast<Dart_IsolateCleanupCallback>( |
| DartIsolateCleanupCallback), |
| /*child_isolate_data=*/isolate_data, |
| /*error=*/error); |
| }; |
| } else { |
| isolate_maker = [](std::shared_ptr<DartIsolateGroupData>* |
| isolate_group_data, |
| std::shared_ptr<DartIsolate>* isolate_data, |
| Dart_IsolateFlags* flags, char** error) { |
| return Dart_CreateIsolateGroup( |
| (*isolate_group_data)->GetAdvisoryScriptURI().c_str(), |
| (*isolate_group_data)->GetAdvisoryScriptEntrypoint().c_str(), |
| (*isolate_group_data)->GetIsolateSnapshot()->GetDataMapping(), |
| (*isolate_group_data)->GetIsolateSnapshot()->GetInstructionsMapping(), |
| flags, isolate_group_data, isolate_data, error); |
| }; |
| } |
| |
| vm_isolate = CreateDartIsolateGroup(std::move(isolate_group_data), |
| std::move(isolate_data), &isolate_flags, |
| error.error(), isolate_maker); |
| |
| if (error) { |
| FML_LOG(ERROR) << "CreateRootIsolate failed: " << error.str(); |
| } |
| |
| if (vm_isolate == nullptr) { |
| return {}; |
| } |
| |
| std::shared_ptr<DartIsolate>* root_isolate_data = |
| static_cast<std::shared_ptr<DartIsolate>*>(Dart_IsolateData(vm_isolate)); |
| |
| (*root_isolate_data) |
| ->SetPlatformConfiguration(std::move(platform_configuration)); |
| |
| return (*root_isolate_data)->GetWeakIsolatePtr(); |
| } |
| |
| DartIsolate::DartIsolate(const Settings& settings, |
| bool is_root_isolate, |
| const UIDartState::Context& context) |
| : UIDartState(settings.task_observer_add, |
| settings.task_observer_remove, |
| settings.log_tag, |
| settings.unhandled_exception_callback, |
| settings.log_message_callback, |
| DartVMRef::GetIsolateNameServer(), |
| is_root_isolate, |
| settings.enable_skparagraph, |
| settings.enable_display_list, |
| std::move(context)), |
| may_insecurely_connect_to_all_domains_( |
| settings.may_insecurely_connect_to_all_domains), |
| domain_network_policy_(settings.domain_network_policy) { |
| phase_ = Phase::Uninitialized; |
| } |
| |
| DartIsolate::~DartIsolate() { |
| if (IsRootIsolate() && GetMessageHandlingTaskRunner()) { |
| FML_DCHECK(GetMessageHandlingTaskRunner()->RunsTasksOnCurrentThread()); |
| } |
| } |
| |
| DartIsolate::Phase DartIsolate::GetPhase() const { |
| return phase_; |
| } |
| |
| std::string DartIsolate::GetServiceId() { |
| const char* service_id_buf = Dart_IsolateServiceId(isolate()); |
| std::string service_id(service_id_buf); |
| free(const_cast<char*>(service_id_buf)); |
| return service_id; |
| } |
| |
| bool DartIsolate::Initialize(Dart_Isolate dart_isolate) { |
| TRACE_EVENT0("flutter", "DartIsolate::Initialize"); |
| if (phase_ != Phase::Uninitialized) { |
| return false; |
| } |
| |
| if (dart_isolate == nullptr) { |
| return false; |
| } |
| |
| if (Dart_CurrentIsolate() != dart_isolate) { |
| return false; |
| } |
| |
| // After this point, isolate scopes can be safely used. |
| SetIsolate(dart_isolate); |
| |
| // We are entering a new scope (for the first time since initialization) and |
| // we want to restore the current scope to null when we exit out of this |
| // method. This balances the implicit Dart_EnterIsolate call made by |
| // Dart_CreateIsolateGroup (which calls the Initialize). |
| Dart_ExitIsolate(); |
| |
| tonic::DartIsolateScope scope(isolate()); |
| |
| // For the root isolate set the "AppStartUp" as soon as the root isolate |
| // has been initialized. This is to ensure that all the timeline events |
| // that have the set user-tag will be listed user AppStartUp. |
| if (IsRootIsolate()) { |
| tonic::DartApiScope api_scope; |
| Dart_SetCurrentUserTag(Dart_NewUserTag("AppStartUp")); |
| } |
| |
| SetMessageHandlingTaskRunner(GetTaskRunners().GetUITaskRunner()); |
| |
| if (tonic::LogIfError( |
| Dart_SetLibraryTagHandler(tonic::DartState::HandleLibraryTag))) { |
| return false; |
| } |
| |
| if (tonic::LogIfError(Dart_SetDeferredLoadHandler(OnDartLoadLibrary))) { |
| return false; |
| } |
| |
| if (!UpdateThreadPoolNames()) { |
| return false; |
| } |
| |
| phase_ = Phase::Initialized; |
| return true; |
| } |
| |
| fml::RefPtr<fml::TaskRunner> DartIsolate::GetMessageHandlingTaskRunner() const { |
| return message_handling_task_runner_; |
| } |
| |
| bool DartIsolate::LoadLoadingUnit( |
| intptr_t loading_unit_id, |
| std::unique_ptr<const fml::Mapping> snapshot_data, |
| std::unique_ptr<const fml::Mapping> snapshot_instructions) { |
| tonic::DartState::Scope scope(this); |
| |
| fml::RefPtr<DartSnapshot> dart_snapshot = |
| DartSnapshot::IsolateSnapshotFromMappings( |
| std::move(snapshot_data), std::move(snapshot_instructions)); |
| |
| Dart_Handle result = Dart_DeferredLoadComplete( |
| loading_unit_id, dart_snapshot->GetDataMapping(), |
| dart_snapshot->GetInstructionsMapping()); |
| if (tonic::LogIfError(result)) { |
| LoadLoadingUnitError(loading_unit_id, Dart_GetError(result), |
| /*transient*/ true); |
| return false; |
| } |
| loading_unit_snapshots_.insert(dart_snapshot); |
| return true; |
| } |
| |
| void DartIsolate::LoadLoadingUnitError(intptr_t loading_unit_id, |
| const std::string error_message, |
| bool transient) { |
| tonic::DartState::Scope scope(this); |
| Dart_Handle result = Dart_DeferredLoadCompleteError( |
| loading_unit_id, error_message.c_str(), transient); |
| tonic::LogIfError(result); |
| } |
| |
| void DartIsolate::SetMessageHandlingTaskRunner( |
| fml::RefPtr<fml::TaskRunner> runner) { |
| if (!IsRootIsolate() || !runner) { |
| return; |
| } |
| |
| message_handling_task_runner_ = runner; |
| |
| message_handler().Initialize([runner](std::function<void()> task) { |
| #ifdef OS_FUCHSIA |
| runner->PostTask([task = std::move(task)]() { |
| TRACE_EVENT0("flutter", "DartIsolate::HandleMessage"); |
| task(); |
| }); |
| #else |
| auto task_queues = fml::MessageLoopTaskQueues::GetInstance(); |
| task_queues->RegisterTask( |
| runner->GetTaskQueueId(), |
| [task = std::move(task)]() { |
| TRACE_EVENT0("flutter", "DartIsolate::HandleMessage"); |
| task(); |
| }, |
| fml::TimePoint::Now(), fml::TaskSourceGrade::kDartMicroTasks); |
| #endif |
| }); |
| } |
| |
| // Updating thread names here does not change the underlying OS thread names. |
| // Instead, this is just additional metadata for the Observatory to show the |
| // thread name of the isolate. |
| bool DartIsolate::UpdateThreadPoolNames() const { |
| // TODO(chinmaygarde): This implementation does not account for multiple |
| // shells sharing the same (or subset of) threads. |
| const auto& task_runners = GetTaskRunners(); |
| |
| if (auto task_runner = task_runners.GetRasterTaskRunner()) { |
| task_runner->PostTask( |
| [label = task_runners.GetLabel() + std::string{".raster"}]() { |
| Dart_SetThreadName(label.c_str()); |
| }); |
| } |
| |
| if (auto task_runner = task_runners.GetUITaskRunner()) { |
| task_runner->PostTask( |
| [label = task_runners.GetLabel() + std::string{".ui"}]() { |
| Dart_SetThreadName(label.c_str()); |
| }); |
| } |
| |
| if (auto task_runner = task_runners.GetIOTaskRunner()) { |
| task_runner->PostTask( |
| [label = task_runners.GetLabel() + std::string{".io"}]() { |
| Dart_SetThreadName(label.c_str()); |
| }); |
| } |
| |
| if (auto task_runner = task_runners.GetPlatformTaskRunner()) { |
| task_runner->PostTask( |
| [label = task_runners.GetLabel() + std::string{".platform"}]() { |
| Dart_SetThreadName(label.c_str()); |
| }); |
| } |
| |
| return true; |
| } |
| |
| bool DartIsolate::LoadLibraries() { |
| TRACE_EVENT0("flutter", "DartIsolate::LoadLibraries"); |
| if (phase_ != Phase::Initialized) { |
| return false; |
| } |
| |
| tonic::DartState::Scope scope(this); |
| |
| DartIO::InitForIsolate(may_insecurely_connect_to_all_domains_, |
| domain_network_policy_); |
| |
| DartUI::InitForIsolate(); |
| |
| const bool is_service_isolate = Dart_IsServiceIsolate(isolate()); |
| |
| DartRuntimeHooks::Install(IsRootIsolate() && !is_service_isolate, |
| GetAdvisoryScriptURI()); |
| |
| if (!is_service_isolate) { |
| class_library().add_provider( |
| "ui", std::make_unique<tonic::DartClassProvider>(this, "dart:ui")); |
| } |
| |
| phase_ = Phase::LibrariesSetup; |
| return true; |
| } |
| |
| bool DartIsolate::PrepareForRunningFromPrecompiledCode() { |
| TRACE_EVENT0("flutter", "DartIsolate::PrepareForRunningFromPrecompiledCode"); |
| if (phase_ != Phase::LibrariesSetup) { |
| return false; |
| } |
| |
| tonic::DartState::Scope scope(this); |
| |
| if (Dart_IsNull(Dart_RootLibrary())) { |
| return false; |
| } |
| |
| if (!MarkIsolateRunnable()) { |
| return false; |
| } |
| |
| if (GetIsolateGroupData().GetChildIsolatePreparer() == nullptr) { |
| GetIsolateGroupData().SetChildIsolatePreparer([](DartIsolate* isolate) { |
| return isolate->PrepareForRunningFromPrecompiledCode(); |
| }); |
| } |
| |
| const fml::closure& isolate_create_callback = |
| GetIsolateGroupData().GetIsolateCreateCallback(); |
| if (isolate_create_callback) { |
| isolate_create_callback(); |
| } |
| |
| phase_ = Phase::Ready; |
| return true; |
| } |
| |
| bool DartIsolate::LoadKernel(std::shared_ptr<const fml::Mapping> mapping, |
| bool last_piece) { |
| if (!Dart_IsKernel(mapping->GetMapping(), mapping->GetSize())) { |
| return false; |
| } |
| |
| // Mapping must be retained until isolate shutdown. |
| kernel_buffers_.push_back(mapping); |
| |
| Dart_Handle library = |
| Dart_LoadLibraryFromKernel(mapping->GetMapping(), mapping->GetSize()); |
| if (tonic::LogIfError(library)) { |
| return false; |
| } |
| |
| if (!last_piece) { |
| // More to come. |
| return true; |
| } |
| |
| Dart_SetRootLibrary(library); |
| if (tonic::LogIfError(Dart_FinalizeLoading(false))) { |
| return false; |
| } |
| return true; |
| } |
| |
| [[nodiscard]] bool DartIsolate::PrepareForRunningFromKernel( |
| std::shared_ptr<const fml::Mapping> mapping, |
| bool child_isolate, |
| bool last_piece) { |
| TRACE_EVENT0("flutter", "DartIsolate::PrepareForRunningFromKernel"); |
| if (phase_ != Phase::LibrariesSetup) { |
| return false; |
| } |
| |
| if (DartVM::IsRunningPrecompiledCode()) { |
| return false; |
| } |
| |
| if (!mapping || mapping->GetSize() == 0) { |
| return false; |
| } |
| |
| tonic::DartState::Scope scope(this); |
| |
| if (!child_isolate || !Dart_IsVMFlagSet("--enable-isolate-groups")) { |
| // Use root library provided by kernel in favor of one provided by snapshot. |
| Dart_SetRootLibrary(Dart_Null()); |
| |
| if (!LoadKernel(mapping, last_piece)) { |
| return false; |
| } |
| } |
| |
| if (!last_piece) { |
| // More to come. |
| return true; |
| } |
| |
| if (Dart_IsNull(Dart_RootLibrary())) { |
| return false; |
| } |
| |
| if (!MarkIsolateRunnable()) { |
| return false; |
| } |
| |
| // Child isolate shares root isolate embedder_isolate (lines 691 and 693 |
| // below). Re-initializing child_isolate_preparer_ lambda while it is being |
| // executed leads to crashes. |
| if (GetIsolateGroupData().GetChildIsolatePreparer() == nullptr) { |
| GetIsolateGroupData().SetChildIsolatePreparer( |
| [buffers = kernel_buffers_](DartIsolate* isolate) { |
| for (uint64_t i = 0; i < buffers.size(); i++) { |
| bool last_piece = i + 1 == buffers.size(); |
| const std::shared_ptr<const fml::Mapping>& buffer = buffers.at(i); |
| if (!isolate->PrepareForRunningFromKernel(buffer, |
| /*child_isolate=*/true, |
| last_piece)) { |
| return false; |
| } |
| } |
| return true; |
| }); |
| } |
| |
| const fml::closure& isolate_create_callback = |
| GetIsolateGroupData().GetIsolateCreateCallback(); |
| if (isolate_create_callback) { |
| isolate_create_callback(); |
| } |
| |
| phase_ = Phase::Ready; |
| |
| return true; |
| } |
| |
| [[nodiscard]] bool DartIsolate::PrepareForRunningFromKernels( |
| std::vector<std::shared_ptr<const fml::Mapping>> kernels) { |
| const auto count = kernels.size(); |
| if (count == 0) { |
| return false; |
| } |
| |
| for (size_t i = 0; i < count; ++i) { |
| bool last = (i == (count - 1)); |
| if (!PrepareForRunningFromKernel(kernels[i], /*child_isolate=*/false, |
| last)) { |
| return false; |
| } |
| } |
| |
| return true; |
| } |
| |
| [[nodiscard]] bool DartIsolate::PrepareForRunningFromKernels( |
| std::vector<std::unique_ptr<const fml::Mapping>> kernels) { |
| std::vector<std::shared_ptr<const fml::Mapping>> shared_kernels; |
| for (auto& kernel : kernels) { |
| shared_kernels.emplace_back(std::move(kernel)); |
| } |
| return PrepareForRunningFromKernels(shared_kernels); |
| } |
| |
| bool DartIsolate::MarkIsolateRunnable() { |
| TRACE_EVENT0("flutter", "DartIsolate::MarkIsolateRunnable"); |
| if (phase_ != Phase::LibrariesSetup) { |
| return false; |
| } |
| |
| // This function may only be called from an active isolate scope. |
| if (Dart_CurrentIsolate() != isolate()) { |
| return false; |
| } |
| |
| // There must be no current isolate to mark an isolate as being runnable. |
| Dart_ExitIsolate(); |
| |
| char* error = Dart_IsolateMakeRunnable(isolate()); |
| if (error) { |
| FML_DLOG(ERROR) << error; |
| ::free(error); |
| // Failed. Restore the isolate. |
| Dart_EnterIsolate(isolate()); |
| return false; |
| } |
| // Success. Restore the isolate. |
| Dart_EnterIsolate(isolate()); |
| return true; |
| } |
| |
| [[nodiscard]] static bool InvokeMainEntrypoint( |
| Dart_Handle user_entrypoint_function, |
| Dart_Handle args) { |
| if (tonic::LogIfError(user_entrypoint_function)) { |
| FML_LOG(ERROR) << "Could not resolve main entrypoint function."; |
| return false; |
| } |
| |
| Dart_Handle start_main_isolate_function = |
| tonic::DartInvokeField(Dart_LookupLibrary(tonic::ToDart("dart:isolate")), |
| "_getStartMainIsolateFunction", {}); |
| |
| if (tonic::LogIfError(start_main_isolate_function)) { |
| FML_LOG(ERROR) << "Could not resolve main entrypoint trampoline."; |
| return false; |
| } |
| |
| if (tonic::LogIfError(tonic::DartInvokeField( |
| Dart_LookupLibrary(tonic::ToDart("dart:ui")), "_runMainZoned", |
| {start_main_isolate_function, user_entrypoint_function, args}))) { |
| FML_LOG(ERROR) << "Could not invoke the main entrypoint."; |
| return false; |
| } |
| |
| return true; |
| } |
| |
| static void InvokeDartPluginRegistrantIfAvailable(Dart_Handle library_handle) { |
| TRACE_EVENT0("flutter", "InvokeDartPluginRegistrantIfAvailable"); |
| |
| // The Dart plugin registrant is a static method with signature `void |
| // register()` within the class `_PluginRegistrant` generated by the Flutter |
| // tool. |
| // |
| // This method binds a plugin implementation to their platform |
| // interface based on the configuration of the app's pubpec.yaml, and the |
| // plugin's pubspec.yaml. |
| // |
| // Since this method may or may not be defined, check if the class is defined |
| // in the default library before calling the method. |
| Dart_Handle plugin_registrant = |
| ::Dart_GetClass(library_handle, tonic::ToDart("_PluginRegistrant")); |
| |
| if (Dart_IsError(plugin_registrant)) { |
| return; |
| } |
| tonic::LogIfError(tonic::DartInvokeField(plugin_registrant, "register", {})); |
| } |
| |
| bool DartIsolate::RunFromLibrary(std::optional<std::string> library_name, |
| std::optional<std::string> entrypoint, |
| const std::vector<std::string>& args) { |
| TRACE_EVENT0("flutter", "DartIsolate::RunFromLibrary"); |
| if (phase_ != Phase::Ready) { |
| return false; |
| } |
| |
| tonic::DartState::Scope scope(this); |
| |
| auto library_handle = |
| library_name.has_value() && !library_name.value().empty() |
| ? ::Dart_LookupLibrary(tonic::ToDart(library_name.value().c_str())) |
| : ::Dart_RootLibrary(); |
| auto entrypoint_handle = entrypoint.has_value() && !entrypoint.value().empty() |
| ? tonic::ToDart(entrypoint.value().c_str()) |
| : tonic::ToDart("main"); |
| |
| InvokeDartPluginRegistrantIfAvailable(library_handle); |
| |
| auto user_entrypoint_function = |
| ::Dart_GetField(library_handle, entrypoint_handle); |
| |
| auto entrypoint_args = tonic::ToDart(args); |
| |
| if (!InvokeMainEntrypoint(user_entrypoint_function, entrypoint_args)) { |
| return false; |
| } |
| |
| phase_ = Phase::Running; |
| |
| return true; |
| } |
| |
| bool DartIsolate::Shutdown() { |
| TRACE_EVENT0("flutter", "DartIsolate::Shutdown"); |
| // This call may be re-entrant since Dart_ShutdownIsolate can invoke the |
| // cleanup callback which deletes the embedder side object of the dart isolate |
| // (a.k.a. this). |
| if (phase_ == Phase::Shutdown) { |
| return false; |
| } |
| phase_ = Phase::Shutdown; |
| Dart_Isolate vm_isolate = isolate(); |
| // The isolate can be nullptr if this instance is the stub isolate data used |
| // during root isolate creation. |
| if (vm_isolate != nullptr) { |
| // We need to enter the isolate because Dart_ShutdownIsolate does not take |
| // the isolate to shutdown as a parameter. |
| FML_DCHECK(Dart_CurrentIsolate() == nullptr); |
| Dart_EnterIsolate(vm_isolate); |
| Dart_ShutdownIsolate(); |
| FML_DCHECK(Dart_CurrentIsolate() == nullptr); |
| } |
| return true; |
| } |
| |
| Dart_Isolate DartIsolate::DartCreateAndStartServiceIsolate( |
| const char* package_root, |
| const char* package_config, |
| Dart_IsolateFlags* flags, |
| char** error) { |
| auto vm_data = DartVMRef::GetVMData(); |
| |
| if (!vm_data) { |
| *error = fml::strdup( |
| "Could not access VM data to initialize isolates. This may be because " |
| "the VM has initialized shutdown on another thread already."); |
| return nullptr; |
| } |
| |
| const auto& settings = vm_data->GetSettings(); |
| |
| if (!settings.enable_observatory) { |
| return nullptr; |
| } |
| |
| flags->load_vmservice_library = true; |
| |
| #if (FLUTTER_RUNTIME_MODE != FLUTTER_RUNTIME_MODE_DEBUG) |
| // TODO(68663): The service isolate in debug mode is always launched without |
| // sound null safety. Fix after the isolate snapshot data is created with the |
| // right flags. |
| flags->null_safety = |
| vm_data->GetIsolateSnapshot()->IsNullSafetyEnabled(nullptr); |
| #endif |
| |
| UIDartState::Context context( |
| TaskRunners("io.flutter." DART_VM_SERVICE_ISOLATE_NAME, nullptr, nullptr, |
| nullptr, nullptr)); |
| context.advisory_script_uri = DART_VM_SERVICE_ISOLATE_NAME; |
| context.advisory_script_entrypoint = DART_VM_SERVICE_ISOLATE_NAME; |
| std::weak_ptr<DartIsolate> weak_service_isolate = |
| DartIsolate::CreateRootIsolate(vm_data->GetSettings(), // |
| vm_data->GetIsolateSnapshot(), // |
| nullptr, // |
| DartIsolate::Flags{flags}, // |
| nullptr, // |
| nullptr, // |
| context); // |
| |
| std::shared_ptr<DartIsolate> service_isolate = weak_service_isolate.lock(); |
| if (!service_isolate) { |
| *error = fml::strdup("Could not create the service isolate."); |
| FML_DLOG(ERROR) << *error; |
| return nullptr; |
| } |
| |
| tonic::DartState::Scope scope(service_isolate); |
| if (!DartServiceIsolate::Startup( |
| settings.observatory_host, // server IP address |
| settings.observatory_port, // server observatory port |
| tonic::DartState::HandleLibraryTag, // embedder library tag handler |
| false, // disable websocket origin check |
| settings.disable_service_auth_codes, // disable VM service auth codes |
| settings.enable_service_port_fallback, // enable fallback to port 0 |
| // when bind fails. |
| error // error (out) |
| )) { |
| // Error is populated by call to startup. |
| FML_DLOG(ERROR) << *error; |
| return nullptr; |
| } |
| |
| if (auto callback = vm_data->GetSettings().service_isolate_create_callback) { |
| callback(); |
| } |
| |
| if (auto service_protocol = DartVMRef::GetServiceProtocol()) { |
| service_protocol->ToggleHooks(true); |
| } else { |
| FML_DLOG(ERROR) |
| << "Could not acquire the service protocol handlers. This might be " |
| "because the VM has already begun teardown on another thread."; |
| } |
| |
| return service_isolate->isolate(); |
| } |
| |
| DartIsolateGroupData& DartIsolate::GetIsolateGroupData() { |
| std::shared_ptr<DartIsolateGroupData>* isolate_group_data = |
| static_cast<std::shared_ptr<DartIsolateGroupData>*>( |
| Dart_IsolateGroupData(isolate())); |
| return **isolate_group_data; |
| } |
| |
| const DartIsolateGroupData& DartIsolate::GetIsolateGroupData() const { |
| DartIsolate* non_const_this = const_cast<DartIsolate*>(this); |
| return non_const_this->GetIsolateGroupData(); |
| } |
| |
| // |Dart_IsolateGroupCreateCallback| |
| Dart_Isolate DartIsolate::DartIsolateGroupCreateCallback( |
| const char* advisory_script_uri, |
| const char* advisory_script_entrypoint, |
| const char* package_root, |
| const char* package_config, |
| Dart_IsolateFlags* flags, |
| std::shared_ptr<DartIsolate>* parent_isolate_data, |
| char** error) { |
| TRACE_EVENT0("flutter", "DartIsolate::DartIsolateGroupCreateCallback"); |
| if (parent_isolate_data == nullptr && |
| strcmp(advisory_script_uri, DART_VM_SERVICE_ISOLATE_NAME) == 0) { |
| // The VM attempts to start the VM service for us on |Dart_Initialize|. In |
| // such a case, the callback data will be null and the script URI will be |
| // DART_VM_SERVICE_ISOLATE_NAME. In such cases, we just create the service |
| // isolate like normal but dont hold a reference to it at all. We also start |
| // this isolate since we will never again reference it from the engine. |
| return DartCreateAndStartServiceIsolate(package_root, // |
| package_config, // |
| flags, // |
| error // |
| ); |
| } |
| |
| if (!parent_isolate_data) { |
| return nullptr; |
| } |
| |
| DartIsolateGroupData& parent_group_data = |
| (*parent_isolate_data)->GetIsolateGroupData(); |
| |
| if (strncmp(advisory_script_uri, kFileUriPrefix.data(), |
| kFileUriPrefix.size())) { |
| std::string error_msg = |
| std::string("Unsupported isolate URI: ") + advisory_script_uri; |
| *error = fml::strdup(error_msg.c_str()); |
| return nullptr; |
| } |
| |
| auto isolate_group_data = |
| std::make_unique<std::shared_ptr<DartIsolateGroupData>>( |
| std::shared_ptr<DartIsolateGroupData>(new DartIsolateGroupData( |
| parent_group_data.GetSettings(), |
| parent_group_data.GetIsolateSnapshot(), advisory_script_uri, |
| advisory_script_entrypoint, |
| parent_group_data.GetChildIsolatePreparer(), |
| parent_group_data.GetIsolateCreateCallback(), |
| parent_group_data.GetIsolateShutdownCallback()))); |
| |
| TaskRunners null_task_runners(advisory_script_uri, |
| /* platform= */ nullptr, |
| /* raster= */ nullptr, |
| /* ui= */ nullptr, |
| /* io= */ nullptr); |
| |
| UIDartState::Context context(null_task_runners); |
| context.advisory_script_uri = advisory_script_uri; |
| context.advisory_script_entrypoint = advisory_script_entrypoint; |
| auto isolate_data = std::make_unique<std::shared_ptr<DartIsolate>>( |
| std::shared_ptr<DartIsolate>( |
| new DartIsolate((*isolate_group_data)->GetSettings(), // settings |
| false, // is_root_isolate |
| context))); // context |
| |
| Dart_Isolate vm_isolate = CreateDartIsolateGroup( |
| std::move(isolate_group_data), std::move(isolate_data), flags, error, |
| [](std::shared_ptr<DartIsolateGroupData>* isolate_group_data, |
| std::shared_ptr<DartIsolate>* isolate_data, Dart_IsolateFlags* flags, |
| char** error) { |
| return Dart_CreateIsolateGroup( |
| (*isolate_group_data)->GetAdvisoryScriptURI().c_str(), |
| (*isolate_group_data)->GetAdvisoryScriptEntrypoint().c_str(), |
| (*isolate_group_data)->GetIsolateSnapshot()->GetDataMapping(), |
| (*isolate_group_data) |
| ->GetIsolateSnapshot() |
| ->GetInstructionsMapping(), |
| flags, isolate_group_data, isolate_data, error); |
| }); |
| |
| if (*error) { |
| FML_LOG(ERROR) << "CreateDartIsolateGroup failed: " << error; |
| } |
| |
| return vm_isolate; |
| } |
| |
| // |Dart_IsolateInitializeCallback| |
| bool DartIsolate::DartIsolateInitializeCallback(void** child_callback_data, |
| char** error) { |
| TRACE_EVENT0("flutter", "DartIsolate::DartIsolateInitializeCallback"); |
| Dart_Isolate isolate = Dart_CurrentIsolate(); |
| if (isolate == nullptr) { |
| *error = fml::strdup("Isolate should be available in initialize callback."); |
| FML_DLOG(ERROR) << *error; |
| return false; |
| } |
| |
| auto* isolate_group_data = |
| static_cast<std::shared_ptr<DartIsolateGroupData>*>( |
| Dart_CurrentIsolateGroupData()); |
| |
| TaskRunners null_task_runners((*isolate_group_data)->GetAdvisoryScriptURI(), |
| /* platform= */ nullptr, |
| /* raster= */ nullptr, |
| /* ui= */ nullptr, |
| /* io= */ nullptr); |
| |
| UIDartState::Context context(null_task_runners); |
| context.advisory_script_uri = (*isolate_group_data)->GetAdvisoryScriptURI(); |
| context.advisory_script_entrypoint = |
| (*isolate_group_data)->GetAdvisoryScriptEntrypoint(); |
| auto embedder_isolate = std::make_unique<std::shared_ptr<DartIsolate>>( |
| std::shared_ptr<DartIsolate>( |
| new DartIsolate((*isolate_group_data)->GetSettings(), // settings |
| false, // is_root_isolate |
| context))); // context |
| |
| // root isolate should have been created via CreateRootIsolate |
| if (!InitializeIsolate(*embedder_isolate, isolate, error)) { |
| return false; |
| } |
| |
| // The ownership of the embedder object is controlled by the Dart VM. So the |
| // only reference returned to the caller is weak. |
| *child_callback_data = embedder_isolate.release(); |
| |
| Dart_EnterIsolate(isolate); |
| return true; |
| } |
| |
| Dart_Isolate DartIsolate::CreateDartIsolateGroup( |
| std::unique_ptr<std::shared_ptr<DartIsolateGroupData>> isolate_group_data, |
| std::unique_ptr<std::shared_ptr<DartIsolate>> isolate_data, |
| Dart_IsolateFlags* flags, |
| char** error, |
| const DartIsolate::IsolateMaker& make_isolate) { |
| TRACE_EVENT0("flutter", "DartIsolate::CreateDartIsolateGroup"); |
| |
| // Create the Dart VM isolate and give it the embedder object as the baton. |
| Dart_Isolate isolate = |
| make_isolate(isolate_group_data.get(), isolate_data.get(), flags, error); |
| |
| if (isolate == nullptr) { |
| return nullptr; |
| } |
| |
| // Ownership of the isolate data objects has been transferred to the Dart VM. |
| std::shared_ptr<DartIsolate> embedder_isolate(*isolate_data); |
| isolate_group_data.release(); |
| isolate_data.release(); |
| |
| if (!InitializeIsolate(std::move(embedder_isolate), isolate, error)) { |
| return nullptr; |
| } |
| |
| return isolate; |
| } |
| |
| bool DartIsolate::InitializeIsolate( |
| std::shared_ptr<DartIsolate> embedder_isolate, |
| Dart_Isolate isolate, |
| char** error) { |
| TRACE_EVENT0("flutter", "DartIsolate::InitializeIsolate"); |
| if (!embedder_isolate->Initialize(isolate)) { |
| *error = fml::strdup("Embedder could not initialize the Dart isolate."); |
| FML_DLOG(ERROR) << *error; |
| return false; |
| } |
| |
| if (!embedder_isolate->LoadLibraries()) { |
| *error = fml::strdup( |
| "Embedder could not load libraries in the new Dart isolate."); |
| FML_DLOG(ERROR) << *error; |
| return false; |
| } |
| |
| // Root isolates will be set up by the engine and the service isolate |
| // (which is also a root isolate) by the utility routines in the VM. |
| // However, secondary isolates will be run by the VM if they are |
| // marked as runnable. |
| if (!embedder_isolate->IsRootIsolate()) { |
| auto child_isolate_preparer = |
| embedder_isolate->GetIsolateGroupData().GetChildIsolatePreparer(); |
| FML_DCHECK(child_isolate_preparer); |
| if (!child_isolate_preparer(embedder_isolate.get())) { |
| *error = fml::strdup("Could not prepare the child isolate to run."); |
| FML_DLOG(ERROR) << *error; |
| return false; |
| } |
| } |
| |
| return true; |
| } |
| |
| // |Dart_IsolateShutdownCallback| |
| void DartIsolate::DartIsolateShutdownCallback( |
| std::shared_ptr<DartIsolateGroupData>* isolate_group_data, |
| std::shared_ptr<DartIsolate>* isolate_data) { |
| TRACE_EVENT0("flutter", "DartIsolate::DartIsolateShutdownCallback"); |
| isolate_data->get()->OnShutdownCallback(); |
| } |
| |
| // |Dart_IsolateGroupCleanupCallback| |
| void DartIsolate::DartIsolateGroupCleanupCallback( |
| std::shared_ptr<DartIsolateGroupData>* isolate_data) { |
| TRACE_EVENT0("flutter", "DartIsolate::DartIsolateGroupCleanupCallback"); |
| delete isolate_data; |
| } |
| |
| // |Dart_IsolateCleanupCallback| |
| void DartIsolate::DartIsolateCleanupCallback( |
| std::shared_ptr<DartIsolateGroupData>* isolate_group_data, |
| std::shared_ptr<DartIsolate>* isolate_data) { |
| TRACE_EVENT0("flutter", "DartIsolate::DartIsolateCleanupCallback"); |
| delete isolate_data; |
| } |
| |
| std::weak_ptr<DartIsolate> DartIsolate::GetWeakIsolatePtr() { |
| return std::static_pointer_cast<DartIsolate>(shared_from_this()); |
| } |
| |
| void DartIsolate::AddIsolateShutdownCallback(const fml::closure& closure) { |
| shutdown_callbacks_.emplace_back(std::make_unique<AutoFireClosure>(closure)); |
| } |
| |
| void DartIsolate::OnShutdownCallback() { |
| tonic::DartState* state = tonic::DartState::Current(); |
| if (state != nullptr) { |
| state->SetIsShuttingDown(); |
| } |
| |
| { |
| tonic::DartApiScope api_scope; |
| Dart_Handle sticky_error = Dart_GetStickyError(); |
| if (!Dart_IsNull(sticky_error) && !Dart_IsFatalError(sticky_error)) { |
| FML_LOG(ERROR) << Dart_GetError(sticky_error); |
| } |
| } |
| |
| shutdown_callbacks_.clear(); |
| |
| const fml::closure& isolate_shutdown_callback = |
| GetIsolateGroupData().GetIsolateShutdownCallback(); |
| if (isolate_shutdown_callback) { |
| isolate_shutdown_callback(); |
| } |
| } |
| |
| Dart_Handle DartIsolate::OnDartLoadLibrary(intptr_t loading_unit_id) { |
| if (Current()->platform_configuration()) { |
| Current()->platform_configuration()->client()->RequestDartDeferredLibrary( |
| loading_unit_id); |
| return Dart_Null(); |
| } |
| const std::string error_message = |
| "Platform Configuration was null. Deferred library load request" |
| "for loading unit id " + |
| std::to_string(loading_unit_id) + " was not sent."; |
| FML_LOG(ERROR) << error_message; |
| return Dart_NewApiError(error_message.c_str()); |
| } |
| |
| DartIsolate::AutoFireClosure::AutoFireClosure(const fml::closure& closure) |
| : closure_(closure) {} |
| |
| DartIsolate::AutoFireClosure::~AutoFireClosure() { |
| if (closure_) { |
| closure_(); |
| } |
| } |
| |
| } // namespace flutter |
