Provides thread-safe access to data that is necessary to bootstrap a new Dart VM instance. All snapshots referenced by this object are read-only. More...

#include <dart_vm_data.h>

Public Member Functions
	~DartVMData ()
	Collect the DartVMData instance. More...

const Settings &	GetSettings () const
	The settings object from which the Dart snapshots were inferred. More...

const DartSnapshot &	GetVMSnapshot () const
	Gets the VM snapshot. This can be in the call to bootstrap the Dart VM via `Dart_Initialize`. More...

fml::RefPtr< const DartSnapshot >	GetIsolateSnapshot () const
	Get the isolate snapshot necessary to launch isolates in the Dart VM. The Dart VM instance in which these isolates are launched must be the same as the VM created using snapshot accessed via `GetVMSnapshot`. More...

fml::RefPtr< const DartSnapshot >	GetServiceIsolateSnapshot () const
	Get the isolate snapshot used to launch the service isolate in the Dart VM. More...

bool	GetServiceIsolateSnapshotNullSafety () const
	Returns whether the service isolate snapshot requires null safety in the Dart_IsolateFlags used to create the isolate. More...

Static Public Member Functions
static std::shared_ptr< const DartVMData >	Create (const Settings &settings, fml::RefPtr< const DartSnapshot > vm_snapshot, fml::RefPtr< const DartSnapshot > isolate_snapshot)
	Creates a new instance of `DartVMData`. Both the VM and isolate snapshot members are optional and may be `nullptr`. If `nullptr`, the snapshot resolvers present in the settings object are used to infer the snapshots. If the snapshots cannot be inferred from the settings object, this method return `nullptr`. More...

Detailed Description

Provides thread-safe access to data that is necessary to bootstrap a new Dart VM instance. All snapshots referenced by this object are read-only.

Definition at line 18 of file dart_vm_data.h.

Constructor & Destructor Documentation

◆ ~DartVMData()

flutter::DartVMData::~DartVMData ( )

default

Collect the DartVMData instance.

Member Function Documentation

◆ Create()

std::shared_ptr< const DartVMData > flutter::DartVMData::Create	(	const Settings &	settings,
		fml::RefPtr< const DartSnapshot >	vm_snapshot,
		fml::RefPtr< const DartSnapshot >	isolate_snapshot
	)

static

Creates a new instance of DartVMData. Both the VM and isolate snapshot members are optional and may be nullptr. If nullptr, the snapshot resolvers present in the settings object are used to infer the snapshots. If the snapshots cannot be inferred from the settings object, this method return nullptr.

Parameters

[in]	settings	The settings used to infer the VM and isolate snapshots if they are not provided directly.
[in]	vm_snapshot	The VM snapshot or `nullptr`.
[in]	isolate_snapshot	The isolate snapshot or `nullptr`.

Returns: A new instance of VM data that can be used to bootstrap a Dart VM. nullptr if the snapshots are not provided and cannot be inferred from the settings object.

Definition at line 11 of file dart_vm_data.cc.

                                                    {
  if (!vm_snapshot || !vm_snapshot->IsValid()) {
    // Caller did not provide a valid VM snapshot. Attempt to infer one
    // from the settings.
    vm_snapshot = DartSnapshot::VMSnapshotFromSettings(settings);
    if (!vm_snapshot) {
      FML_LOG(ERROR)
          << "VM snapshot invalid and could not be inferred from settings.";
      return {};
    }
  }
 
  if (!isolate_snapshot || !isolate_snapshot->IsValid()) {
    // Caller did not provide a valid isolate snapshot. Attempt to infer one
    // from the settings.
    isolate_snapshot = DartSnapshot::IsolateSnapshotFromSettings(settings);
    if (!isolate_snapshot) {
      FML_LOG(ERROR) << "Isolate snapshot invalid and could not be inferred "
                        "from settings.";
      return {};
    }
  }
 
  fml::RefPtr<const DartSnapshot> service_isolate_snapshot =
      DartSnapshot::VMServiceIsolateSnapshotFromSettings(settings);
 
  return std::shared_ptr<const DartVMData>(new DartVMData(
      settings,                            //
      std::move(vm_snapshot),              //
      std::move(isolate_snapshot),         //
      std::move(service_isolate_snapshot)  //
      ));
}

◆ GetIsolateSnapshot()

fml::RefPtr< const DartSnapshot > flutter::DartVMData::GetIsolateSnapshot ( ) const

Get the isolate snapshot necessary to launch isolates in the Dart VM. The Dart VM instance in which these isolates are launched must be the same as the VM created using snapshot accessed via GetVMSnapshot.

Returns: The isolate snapshot.

Definition at line 67 of file dart_vm_data.cc.

                                                                   {
  return isolate_snapshot_;
}

◆ GetServiceIsolateSnapshot()

fml::RefPtr< const DartSnapshot > flutter::DartVMData::GetServiceIsolateSnapshot ( ) const

Get the isolate snapshot used to launch the service isolate in the Dart VM.

Returns: The service isolate snapshot.

Definition at line 71 of file dart_vm_data.cc.

                                                                          {
  // Use the specialized snapshot for the service isolate if the embedder
  // provides one.  Otherwise, use the application snapshot.
  return service_isolate_snapshot_ ? service_isolate_snapshot_
                                   : isolate_snapshot_;
}

◆ GetServiceIsolateSnapshotNullSafety()

bool flutter::DartVMData::GetServiceIsolateSnapshotNullSafety ( ) const

Returns whether the service isolate snapshot requires null safety in the Dart_IsolateFlags used to create the isolate.

Returns: True if the snapshot requires null safety.

Definition at line 78 of file dart_vm_data.cc.

                                                           {
  if (service_isolate_snapshot_) {
    // The specialized snapshot for the service isolate is always built
    // using null safety.  However, calling Dart_DetectNullSafety on
    // the service isolate snapshot will not work as expected - it will
    // instead return a cached value representing the app snapshot.
    return true;
  } else {
    return isolate_snapshot_->IsNullSafetyEnabled(nullptr);
  }
}

◆ GetSettings()

const Settings & flutter::DartVMData::GetSettings ( ) const

The settings object from which the Dart snapshots were inferred.

Returns: The settings.

Definition at line 59 of file dart_vm_data.cc.

                                              {
  return settings_;
}

◆ GetVMSnapshot()

const DartSnapshot & flutter::DartVMData::GetVMSnapshot ( ) const

Gets the VM snapshot. This can be in the call to bootstrap the Dart VM via Dart_Initialize.

Returns: The VM snapshot.

Definition at line 63 of file dart_vm_data.cc.

                                                    {
  return *vm_snapshot_;
}

The documentation for this class was generated from the following files:

runtime/dart_vm_data.h
runtime/dart_vm_data.cc

Public Member Functions

Static Public Member Functions