dart::ServiceIsolate Class Reference

#include <service_isolate.h>

Inheritance diagram for dart::ServiceIsolate:

Static Public Member Functions
static bool	Exists ()
static bool	IsRunning ()
static bool	IsServiceIsolate (const Isolate *isolate)
static bool	IsServiceIsolateDescendant (Isolate *isolate)
static Dart_Port	Port ()
static void	WaitForServiceIsolateStartup ()
static bool	SendServiceRpc (uint8_t *request_json, intptr_t request_json_length, Dart_Port reply_port, char **error)
static void	Run ()
static bool	SendIsolateStartupMessage ()
static bool	SendIsolateShutdownMessage ()
static bool	SendServiceControlMessage (Thread *thread, Dart_Port port_id, intptr_t code, const char *name)
static void	SendServiceExitMessage ()
static void	Shutdown ()
static void	BootVmServiceLibrary ()
static void	RegisterRunningIsolates (const GrowableArray< Dart_Port > &isolate_ports, const GrowableArray< const String * > &isolate_names)
static void	RequestServerInfo (const SendPort &sp)
static void	ControlWebServer (const SendPort &sp, bool enable, const Bool &silenceOutput)
static void	SetServerAddress (const char *address)
static const char *	server_address ()
static void	VisitObjectPointers (ObjectPointerVisitor *visitor)

Static Public Attributes
static const char *	kName = DART_VM_SERVICE_ISOLATE_NAME

Protected Types
enum	State { kStopped , kStarting , kStarted , kStopping }

Static Protected Member Functions
static void	SetServicePort (Dart_Port port)
static void	SetServiceIsolate (Isolate *isolate)
static void	FinishedExiting ()
static void	FinishedInitializing ()
static void	InitializingFailed (char *error)
static void	MaybeMakeServiceIsolate (Isolate *isolate)
static Dart_IsolateGroupCreateCallback	create_group_callback ()

Static Protected Attributes
static Dart_IsolateGroupCreateCallback	create_group_callback_
static Monitor *	monitor_ = new Monitor()
static State	state_ = ServiceIsolate::kStopped
static Isolate *	isolate_ = nullptr
static Dart_Port	port_ = ILLEGAL_PORT
static Dart_Port	origin_ = ILLEGAL_PORT
static char *	server_address_ = nullptr
static char *	startup_failure_reason_ = nullptr

Friends
class	Dart
class	Isolate
class	RunServiceTask
class	ServiceIsolateNatives

Detailed Description

Definition at line 20 of file service_isolate.h.

Member Enumeration Documentation

State

enum dart::ServiceIsolate::State

protected

Enumerator
kStopped
kStarting
kStarted
kStopping

Definition at line 88 of file service_isolate.h.

             {
    kStopped,
    kStarting,
    kStarted,
    kStopping,
  };

Member Function Documentation

BootVmServiceLibrary()

void dart::ServiceIsolate::BootVmServiceLibrary ( )

static

Definition at line 571 of file service_isolate.cc.

                                          {
  Thread* thread = Thread::Current();
  const Library& vmservice_library =
      Library::Handle(Library::LookupLibrary(thread, Symbols::DartVMService()));
  ASSERT(!vmservice_library.IsNull());
  const String& boot_function_name = String::Handle(String::New("boot"));
  const Function& boot_function = Function::Handle(
      vmservice_library.LookupFunctionAllowPrivate(boot_function_name));
  ASSERT(!boot_function.IsNull());
  const Object& result = Object::Handle(
      DartEntry::InvokeFunction(boot_function, Object::empty_array()));
  ASSERT(!result.IsNull());
  if (result.IsUnwindError() || result.IsUnhandledException()) {
    Exceptions::PropagateError(Error::Cast(result));
  }
  Dart_Port port = ILLEGAL_PORT;
  if (result.IsReceivePort()) {
    port = ReceivePort::Cast(result).Id();
  }
  ASSERT(port != ILLEGAL_PORT);
  ServiceIsolate::SetServicePort(port);
}

ControlWebServer()

void dart::ServiceIsolate::ControlWebServer ( const SendPort &  sp, bool  enable, const Bool &  silenceOutput  )

static

Definition at line 121 of file service_isolate.cc.

                                                                 {
  const Array& message = Array::Handle(MakeServerControlMessage(
      sp, VM_SERVICE_WEB_SERVER_CONTROL_MESSAGE_ID, enable, silenceOutput));
  ASSERT(!message.IsNull());
  PortMap::PostMessage(WriteMessage(/* same_group */ false, message, port_,
                                    Message::kNormalPriority));
}

create_group_callback()

static Dart_IsolateGroupCreateCallback dart::ServiceIsolate::create_group_callback ( )

inlinestaticprotected

Definition at line 82 of file service_isolate.h.

                                                                 {
    return create_group_callback_;
  }

Exists()

bool dart::ServiceIsolate::Exists ( )

static

Definition at line 142 of file service_isolate.cc.

                            {
  MonitorLocker ml(monitor_);
  return isolate_ != nullptr;
}

FinishedExiting()

void dart::ServiceIsolate::FinishedExiting ( )

staticprotected

Definition at line 320 of file service_isolate.cc.

                                     {
  MonitorLocker ml(monitor_);
  ASSERT(state_ == kStarted || state_ == kStopping);
  state_ = kStopped;
  port_ = ILLEGAL_PORT;
  isolate_ = nullptr;
  ml.NotifyAll();
}

FinishedInitializing()

void dart::ServiceIsolate::FinishedInitializing ( )

staticprotected

Definition at line 329 of file service_isolate.cc.

                                          {
  MonitorLocker ml(monitor_);
  ASSERT(state_ == kStarting);
  state_ = kStarted;
  ml.NotifyAll();
}

InitializingFailed()

void dart::ServiceIsolate::InitializingFailed ( char *  error )

staticprotected

Definition at line 336 of file service_isolate.cc.

                                                   {
  MonitorLocker ml(monitor_);
  ASSERT(state_ == kStarting);
  state_ = kStopped;
  port_ = ILLEGAL_PORT;
  startup_failure_reason_ = error;
  ml.NotifyAll();
}

IsRunning()

bool dart::ServiceIsolate::IsRunning ( )

static

Definition at line 147 of file service_isolate.cc.

                               {
  MonitorLocker ml(monitor_);
  return (port_ != ILLEGAL_PORT) && (isolate_ != nullptr);
}

IsServiceIsolate()

static bool dart::ServiceIsolate::IsServiceIsolate ( const Isolate *  isolate )

static

IsServiceIsolateDescendant()

bool dart::ServiceIsolate::IsServiceIsolateDescendant ( Isolate *  isolate )

static

Definition at line 152 of file service_isolate.cc.

                                                                {
  MonitorLocker ml(monitor_);
  return isolate->origin_id() == origin_;
}

MaybeMakeServiceIsolate()

void dart::ServiceIsolate::MaybeMakeServiceIsolate ( Isolate *  isolate )

staticprotected

Definition at line 304 of file service_isolate.cc.

                                                       {
  Thread* T = Thread::Current();
  ASSERT(I == T->isolate());
  ASSERT(I != nullptr);
  ASSERT(I->name() != nullptr);
  if (!I->is_service_isolate()) {
    // Not service isolate.
    return;
  }
  if (Exists()) {
    // Service isolate already exists.
    return;
  }
  SetServiceIsolate(I);
}

Port()

Dart_Port dart::ServiceIsolate::Port ( )

static

Definition at line 157 of file service_isolate.cc.

                               {
  MonitorLocker ml(monitor_);
  return port_;
}

RegisterRunningIsolates()

void dart::ServiceIsolate::RegisterRunningIsolates ( const GrowableArray< Dart_Port > &  isolate_ports, const GrowableArray< const String * > &  isolate_names  )

static

Definition at line 594 of file service_isolate.cc.

                                                       {
  auto thread = Thread::Current();
  auto zone = thread->zone();
 
  ASSERT(thread->isolate()->is_service_isolate());
 
  // Obtain "_registerIsolate" function to call.
  const String& library_url = Symbols::DartVMService();
  ASSERT(!library_url.IsNull());
  const Library& library =
      Library::Handle(zone, Library::LookupLibrary(thread, library_url));
  ASSERT(!library.IsNull());
  const String& function_name =
      String::Handle(zone, String::New("_registerIsolate"));
  ASSERT(!function_name.IsNull());
  const Function& register_function_ =
      Function::Handle(zone, library.LookupFunctionAllowPrivate(function_name));
  ASSERT(!register_function_.IsNull());
 
  Integer& port_int = Integer::Handle(zone);
  SendPort& send_port = SendPort::Handle(zone);
  Array& args = Array::Handle(zone, Array::New(3));
  Object& result = Object::Handle(zone);
 
  ASSERT(isolate_ports.length() == isolate_names.length());
  for (intptr_t i = 0; i < isolate_ports.length(); ++i) {
    const Dart_Port port_id = isolate_ports[i];
    const String& name = *isolate_names[i];
 
    port_int = Integer::New(port_id);
    send_port = SendPort::New(port_id);
    args.SetAt(0, port_int);
    args.SetAt(1, send_port);
    args.SetAt(2, name);
    result = DartEntry::InvokeFunction(register_function_, args);
    if (FLAG_trace_service) {
      OS::PrintErr("vm-service: Isolate %s %" Pd64 " registered.\n",
                   name.ToCString(), port_id);
    }
    ASSERT(!result.IsError());
  }
}

RequestServerInfo()

void dart::ServiceIsolate::RequestServerInfo ( const SendPort &  sp )

static

Definition at line 112 of file service_isolate.cc.

                                                         {
  const Array& message = Array::Handle(MakeServerControlMessage(
      sp, VM_SERVICE_SERVER_INFO_MESSAGE_ID, false /* ignored */,
      Bool::Handle() /* ignored */));
  ASSERT(!message.IsNull());
  PortMap::PostMessage(WriteMessage(/* same_group */ false, message, port_,
                                    Message::kNormalPriority));
}

Run()

void dart::ServiceIsolate::Run ( )

static

Definition at line 489 of file service_isolate.cc.

                         {
  {
    MonitorLocker ml(monitor_);
    ASSERT(state_ == kStopped);
    state_ = kStarting;
    ml.NotifyAll();
  }
  // Grab the isolate create callback here to avoid race conditions with tests
  // that change this after Dart_Initialize returns.
  create_group_callback_ = Isolate::CreateGroupCallback();
  if (create_group_callback_ == nullptr) {
    ServiceIsolate::InitializingFailed(
        Utils::StrDup("The 'create_group' callback was not provided"));
    return;
  }
  bool task_started = Dart::thread_pool()->Run<RunServiceTask>();
  ASSERT(task_started);
}

SendIsolateShutdownMessage()

bool dart::ServiceIsolate::SendIsolateShutdownMessage ( )

static

Definition at line 244 of file service_isolate.cc.

                                                {
  if (!IsRunning()) {
    return false;
  }
  Thread* thread = Thread::Current();
  Isolate* isolate = thread->isolate();
  if (isolate->is_vm_isolate()) {
    return false;
  }
 
  Dart_Port main_port = isolate->main_port();
  if (FLAG_trace_service) {
    OS::PrintErr(DART_VM_SERVICE_ISOLATE_NAME ": Isolate %s %" Pd64
                                              " deregistered.\n",
                 isolate->name(), main_port);
  }
  isolate->set_is_service_registered(false);
  return SendServiceControlMessage(thread, main_port,
                                   VM_SERVICE_ISOLATE_SHUTDOWN_MESSAGE_ID,
                                   isolate->name());
}

SendIsolateStartupMessage()

bool dart::ServiceIsolate::SendIsolateStartupMessage ( )

static

Definition at line 221 of file service_isolate.cc.

                                               {
  if (!IsRunning()) {
    return false;
  }
  Thread* thread = Thread::Current();
  Isolate* isolate = thread->isolate();
  if (isolate->is_vm_isolate()) {
    return false;
  }
 
  Dart_Port main_port = Dart_GetMainPortId();
  if (FLAG_trace_service) {
    OS::PrintErr(DART_VM_SERVICE_ISOLATE_NAME ": Isolate %s %" Pd64
                                              " registered.\n",
                 isolate->name(), main_port);
  }
  bool result = SendServiceControlMessage(thread, main_port,
                                          VM_SERVICE_ISOLATE_STARTUP_MESSAGE_ID,
                                          isolate->name());
  isolate->set_is_service_registered(true);
  return result;
}

SendServiceControlMessage()

bool dart::ServiceIsolate::SendServiceControlMessage ( Thread *  thread, Dart_Port  port_id, intptr_t  code, const char *  name  )

static

Definition at line 52 of file service_isolate.cc.

                                                                 {
  Dart_CObject ccode;
  ccode.type = Dart_CObject_kInt32;
  ccode.value.as_int32 = code;
 
  Dart_CObject port_int;
  port_int.type = Dart_CObject_kInt64;
  port_int.value.as_int64 = port_id;
 
  Dart_CObject send_port;
  send_port.type = Dart_CObject_kSendPort;
  send_port.value.as_send_port.id = port_id;
  send_port.value.as_send_port.origin_id = port_id;
 
  Dart_CObject cname;
  cname.type = Dart_CObject_kString;
  cname.value.as_string = const_cast<char*>(name);
 
  Dart_CObject* values[4];
  values[0] = &ccode;
  values[1] = &port_int;
  values[2] = &send_port;
  values[3] = &cname;
 
  Dart_CObject message;
  message.type = Dart_CObject_kArray;
  message.value.as_array.length = 4;
  message.value.as_array.values = values;
 
  return PortMap::PostMessage(WriteApiMessage(thread->zone(), &message, port_,
                                              Message::kNormalPriority));
}

SendServiceExitMessage()

void dart::ServiceIsolate::SendServiceExitMessage ( )

static

Definition at line 266 of file service_isolate.cc.

                                            {
  if (!IsRunning()) {
    return;
  }
  if (FLAG_trace_service) {
    OS::PrintErr(DART_VM_SERVICE_ISOLATE_NAME
                 ": sending service exit message.\n");
  }
 
  Dart_CObject code;
  code.type = Dart_CObject_kInt32;
  code.value.as_int32 = VM_SERVICE_ISOLATE_EXIT_MESSAGE_ID;
  Dart_CObject* values[1] = {&code};
 
  Dart_CObject message;
  message.type = Dart_CObject_kArray;
  message.value.as_array.length = 1;
  message.value.as_array.values = values;
 
  AllocOnlyStackZone zone;
  PortMap::PostMessage(WriteApiMessage(zone.GetZone(), &message, port_,
                                       Message::kNormalPriority));
}

SendServiceRpc()

bool dart::ServiceIsolate::SendServiceRpc ( uint8_t *  request_json, intptr_t  request_json_length, Dart_Port  reply_port, char **  error  )

static

Definition at line 169 of file service_isolate.cc.

                                                  {
  // Keep in sync with "sdk/lib/vmservice/vmservice.dart:_handleNativeRpcCall".
  Dart_CObject opcode;
  opcode.type = Dart_CObject_kInt32;
  opcode.value.as_int32 = VM_SERVICE_METHOD_CALL_FROM_NATIVE;
 
  Dart_CObject message;
  message.type = Dart_CObject_kTypedData;
  message.value.as_typed_data.type = Dart_TypedData_kUint8;
  message.value.as_typed_data.length = request_json_length;
  message.value.as_typed_data.values = request_json;
 
  Dart_CObject send_port;
  send_port.type = Dart_CObject_kSendPort;
  send_port.value.as_send_port.id = reply_port;
  send_port.value.as_send_port.origin_id = ILLEGAL_PORT;
 
  Dart_CObject* request_array[] = {
      &opcode,
      &message,
      &send_port,
  };
 
  Dart_CObject request;
  request.type = Dart_CObject_kArray;
  request.value.as_array.values = request_array;
  request.value.as_array.length = ARRAY_SIZE(request_array);
  ServiceIsolate::WaitForServiceIsolateStartup();
  Dart_Port service_port = ServiceIsolate::Port();
  bool success = false;
  if (service_port != ILLEGAL_PORT) {
    success = Dart_PostCObject(service_port, &request);
    if (!success && error != nullptr) {
      *error = Utils::StrDup("Was unable to post message to service isolate.");
    }
  } else {
    if (error != nullptr) {
      if (startup_failure_reason_ != nullptr) {
        *error = OS::SCreate(/*zone=*/nullptr,
                             "Service isolate failed to start up: %s.",
                             startup_failure_reason_);
      } else {
        *error = Utils::StrDup("No service isolate port was found.");
      }
    }
  }
  return success;
}

server_address()

static const char * dart::ServiceIsolate::server_address ( )

inlinestatic

Definition at line 68 of file service_isolate.h.

{ return server_address_; }

SetServerAddress()

void dart::ServiceIsolate::SetServerAddress ( const char *  address )

static

Definition at line 131 of file service_isolate.cc.

                                                         {
  if (server_address_ != nullptr) {
    free(server_address_);
    server_address_ = nullptr;
  }
  if (address == nullptr) {
    return;
  }
  server_address_ = Utils::StrDup(address);
}

SetServiceIsolate()

void dart::ServiceIsolate::SetServiceIsolate ( Isolate *  isolate )

staticprotected

Definition at line 295 of file service_isolate.cc.

                                                       {
  MonitorLocker ml(monitor_);
  isolate_ = isolate;
  if (isolate_ != nullptr) {
    ASSERT(isolate->is_service_isolate());
    origin_ = isolate_->origin_id();
  }
}

SetServicePort()

void dart::ServiceIsolate::SetServicePort ( Dart_Port  port )

staticprotected

Definition at line 290 of file service_isolate.cc.

                                                  {
  MonitorLocker ml(monitor_);
  port_ = port;
}

Shutdown()

void dart::ServiceIsolate::Shutdown ( )

static

Definition at line 528 of file service_isolate.cc.

                              {
  {
    MonitorLocker ml(monitor_);
    while (state_ == kStarting) {
      ml.Wait();
    }
  }
 
  if (IsRunning()) {
    {
      MonitorLocker ml(monitor_);
      ASSERT(state_ == kStarted);
      state_ = kStopping;
      ml.NotifyAll();
    }
    SendServiceExitMessage();
    {
      MonitorLocker ml(monitor_);
      while (state_ == kStopping) {
        ml.Wait();
      }
      ASSERT(state_ == kStopped);
    }
  } else {
    if (isolate_ != nullptr) {
      // TODO(johnmccutchan,turnidge) When it is possible to properly create
      // the VMService object and set up its shutdown handler in the service
      // isolate's main() function, this case will no longer be possible and
      // can be removed.
      KillServiceIsolate();
    }
  }
  if (server_address_ != nullptr) {
    free(server_address_);
    server_address_ = nullptr;
  }
 
  if (startup_failure_reason_ != nullptr) {
    free(startup_failure_reason_);
    startup_failure_reason_ = nullptr;
  }
}

VisitObjectPointers()

void dart::ServiceIsolate::VisitObjectPointers ( ObjectPointerVisitor *  visitor )

static

Definition at line 639 of file service_isolate.cc.

{}

WaitForServiceIsolateStartup()

void dart::ServiceIsolate::WaitForServiceIsolateStartup ( )

static

Definition at line 162 of file service_isolate.cc.

                                                  {
  MonitorLocker ml(monitor_);
  while (state_ == kStarting) {
    ml.Wait();
  }
}

Friends And Related Function Documentation

Dart

friend class Dart

friend

Definition at line 122 of file service_isolate.h.

Isolate

friend class Isolate

friend

Definition at line 123 of file service_isolate.h.

RunServiceTask

friend class RunServiceTask

friend

Definition at line 124 of file service_isolate.h.

ServiceIsolateNatives

friend class ServiceIsolateNatives

friend

Definition at line 125 of file service_isolate.h.

Member Data Documentation

create_group_callback_

Dart_IsolateGroupCreateCallback dart::ServiceIsolate::create_group_callback_

staticprotected

Initial value:

=
    nullptr

Definition at line 86 of file service_isolate.h.

isolate_

Isolate * dart::ServiceIsolate::isolate_ = nullptr

staticprotected

Definition at line 95 of file service_isolate.h.

kName

const char * dart::ServiceIsolate::kName = DART_VM_SERVICE_ISOLATE_NAME

static

Definition at line 24 of file service_isolate.h.

monitor_

Monitor * dart::ServiceIsolate::monitor_ = new Monitor()

staticprotected

Definition at line 87 of file service_isolate.h.

origin_

Dart_Port dart::ServiceIsolate::origin_ = ILLEGAL_PORT

staticprotected

Definition at line 97 of file service_isolate.h.

port_

Dart_Port dart::ServiceIsolate::port_ = ILLEGAL_PORT

staticprotected

Definition at line 96 of file service_isolate.h.

server_address_

char * dart::ServiceIsolate::server_address_ = nullptr

staticprotected

Definition at line 98 of file service_isolate.h.

startup_failure_reason_

char * dart::ServiceIsolate::startup_failure_reason_ = nullptr

staticprotected

Definition at line 102 of file service_isolate.h.

state_

ServiceIsolate::State dart::ServiceIsolate::state_ = ServiceIsolate::kStopped

staticprotected

Definition at line 94 of file service_isolate.h.

---

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

• third_party/dart-lang/sdk/runtime/vm/service_isolate.h
• third_party/dart-lang/sdk/runtime/vm/service_isolate.cc