flutter::DartVMRef Class Reference

#include <dart_vm_lifecycle.h>

Public Member Functions
	DartVMRef (const DartVMRef &)=default
	DartVMRef (DartVMRef &&)
	~DartVMRef ()
	operator bool () const
DartVM *	get ()
const DartVM *	get () const
DartVM *	operator-> ()
const DartVM *	operator-> () const
DartVM *	operator& ()

Static Public Member Functions
static DartVMRef	Create (const Settings &settings, fml::RefPtr< const DartSnapshot > vm_snapshot=nullptr, fml::RefPtr< const DartSnapshot > isolate_snapshot=nullptr)
static bool	IsInstanceRunning ()
static std::shared_ptr< const DartVMData >	GetVMData ()
static std::shared_ptr< ServiceProtocol >	GetServiceProtocol ()
static std::shared_ptr< IsolateNameServer >	GetIsolateNameServer ()

Friends
class	DartIsolate

Detailed Description

Definition at line 28 of file dart_vm_lifecycle.h.

Constructor & Destructor Documentation

DartVMRef() [1/2]

flutter::DartVMRef::DartVMRef ( const DartVMRef &  )

default

DartVMRef() [2/2]

flutter::DartVMRef::DartVMRef ( DartVMRef &&  )

default

~DartVMRef()

flutter::DartVMRef::~DartVMRef

(

)

Definition at line 33 of file dart_vm_lifecycle.cc.

                      {
  if (!vm_) {
    // If there is no valid VM (possible via a move), there is no way that the
    // decrement on the shared pointer can cause a collection. Avoid acquiring
    // the lifecycle lock in this case. This is just working around a
    // pessimization and not required for correctness.
    return;
  }
  std::scoped_lock lifecycle_lock(gVMMutex);
  vm_.reset();
}

References flutter::gVMMutex.

Member Function Documentation

Create()

DartVMRef flutter::DartVMRef::Create ( const Settings &  settings, fml::RefPtr< const DartSnapshot >  vm_snapshot = nullptr, fml::RefPtr< const DartSnapshot >  isolate_snapshot = nullptr  )

static

Definition at line 45 of file dart_vm_lifecycle.cc.

                                                                            {
  std::scoped_lock lifecycle_lock(gVMMutex);
 
  if (!settings.leak_vm) {
    FML_CHECK(!gVMLeak)
        << "Launch settings indicated that the VM should shut down in the "
           "process when done but a previous launch asked the VM to leak in "
           "the same process. For proper VM shutdown, all VM launches must "
           "indicate that they should shut down when done.";
  }
 
  // If there is already a running VM in the process, grab a strong reference to
  // it.
  if (auto vm = gVM.lock()) {
    FML_DLOG(WARNING) << "Attempted to create a VM in a process where one was "
                         "already running. Ignoring arguments for current VM "
                         "create call and reusing the old VM.";
    // There was already a running VM in the process,
    return DartVMRef{std::move(vm)};
  }
 
  std::scoped_lock dependents_lock(gVMDependentsMutex);
 
  gVMData.reset();
  gVMServiceProtocol.reset();
  gVMIsolateNameServer.reset();
  gVM.reset();
 
  // If there is no VM in the process. Initialize one, hold the weak reference
  // and pass a strong reference to the caller.
  auto isolate_name_server = std::make_shared<IsolateNameServer>();
  auto vm = DartVM::Create(settings,                     //
                           std::move(vm_snapshot),       //
                           std::move(isolate_snapshot),  //
                           isolate_name_server           //
  );
 
  if (!vm) {
    FML_LOG(ERROR) << "Could not create Dart VM instance.";
    return DartVMRef{nullptr};
  }
 
  gVMData = vm->GetVMData();
  gVMServiceProtocol = vm->GetServiceProtocol();
  gVMIsolateNameServer = isolate_name_server;
  gVM = vm;
 
  if (settings.leak_vm) {
    gVMLeak = new std::shared_ptr<DartVM>(vm);
  }
 
  return DartVMRef{std::move(vm)};
}

References FML_CHECK, FML_DLOG, FML_LOG, flutter::gVM, flutter::gVMData, flutter::gVMDependentsMutex, flutter::gVMIsolateNameServer, flutter::gVMLeak, flutter::gVMMutex, flutter::gVMServiceProtocol, and flutter::Settings::leak_vm.

Referenced by flutter::BM_PlatformMessageResponseDartComplete(), flutter::Shell::InferVmInitDataFromSettings(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::TEST_F(), flutter::TEST_F(), flutter::TEST_F(), flutter::TEST_F(), flutter::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), and flutter::testing::PlatformIsolateManagerTest::TestWithRootIsolate().

get() [1/2]

DartVM * flutter::DartVMRef::get ( )

inline

Definition at line 54 of file dart_vm_lifecycle.h.

                {
    FML_DCHECK(vm_);
    return vm_.get();
  }

References FML_DCHECK.

get() [2/2]

const DartVM * flutter::DartVMRef::get ( ) const

inline

Definition at line 59 of file dart_vm_lifecycle.h.

                            {
    FML_DCHECK(vm_);
    return vm_.get();
  }

References FML_DCHECK.

GetIsolateNameServer()

std::shared_ptr< IsolateNameServer > flutter::DartVMRef::GetIsolateNameServer ( )

static

Definition at line 116 of file dart_vm_lifecycle.cc.

                                                                 {
  std::scoped_lock lock(gVMDependentsMutex);
  return gVMIsolateNameServer.lock();
}

References flutter::gVMDependentsMutex, and flutter::gVMIsolateNameServer.

GetServiceProtocol()

std::shared_ptr< ServiceProtocol > flutter::DartVMRef::GetServiceProtocol ( )

static

Definition at line 111 of file dart_vm_lifecycle.cc.

                                                             {
  std::scoped_lock lock(gVMDependentsMutex);
  return gVMServiceProtocol.lock();
}

References flutter::gVMDependentsMutex, and flutter::gVMServiceProtocol.

GetVMData()

std::shared_ptr< const DartVMData > flutter::DartVMRef::GetVMData ( )

static

Definition at line 106 of file dart_vm_lifecycle.cc.

                                                     {
  std::scoped_lock lock(gVMDependentsMutex);
  return gVMData.lock();
}

References flutter::gVMData, and flutter::gVMDependentsMutex.

Referenced by flutter::testing::RunDartCodeInIsolateOnUITaskRunner().

IsInstanceRunning()

bool flutter::DartVMRef::IsInstanceRunning ( )

static

Definition at line 101 of file dart_vm_lifecycle.cc.

                                  {
  std::scoped_lock lock(gVMMutex);
  return !gVM.expired();
}

References flutter::gVM, and flutter::gVMMutex.

Referenced by flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), and flutter::testing::PlatformIsolateManagerTest::TestWithRootIsolate().

operator bool()

flutter::DartVMRef::operator bool ( ) const

inlineexplicit

Definition at line 52 of file dart_vm_lifecycle.h.

{ return static_cast<bool>(vm_); }

operator&()

DartVM * flutter::DartVMRef::operator& ( )

inline

Definition at line 75 of file dart_vm_lifecycle.h.

                      {
    FML_DCHECK(vm_);
    return vm_.get();
  }

References FML_DCHECK.

operator->() [1/2]

DartVM * flutter::DartVMRef::operator-> ( )

inline

Definition at line 64 of file dart_vm_lifecycle.h.

                       {
    FML_DCHECK(vm_);
    return vm_.get();
  }

References FML_DCHECK.

operator->() [2/2]

const DartVM * flutter::DartVMRef::operator-> ( ) const

inline

Definition at line 69 of file dart_vm_lifecycle.h.

                                   {
    FML_DCHECK(vm_);
    return vm_.get();
  }

References FML_DCHECK.

Friends And Related Symbol Documentation

DartIsolate

friend class DartIsolate

friend

Definition at line 81 of file dart_vm_lifecycle.h.

---

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

• runtime/dart_vm_lifecycle.h
• runtime/dart_vm_lifecycle.cc