dart::ServiceEvent Class Reference

#include <service_event.h>

Classes
struct	ExtensionEvent
struct	LogRecord

Public Types
enum	EventKind {   kVMUpdate , kVMFlagUpdate , kIsolateStart , kIsolateRunnable ,   kIsolateExit , kIsolateUpdate , kIsolateReload , kServiceExtensionAdded ,   kPauseStart , kPauseExit , kPauseBreakpoint , kPauseInterrupted ,   kPauseException , kPausePostRequest , kNone , kResume ,   kBreakpointAdded , kBreakpointResolved , kBreakpointRemoved , kBreakpointUpdated ,   kInspect , kDebuggerSettingsUpdate , kGC , kEmbedder ,   kLogging , kExtension , kTimelineEvents , kTimelineStreamSubscriptionsUpdate ,   kUserTagChanged , kCpuSamples , kIllegal }

Public Member Functions
	ServiceEvent (EventKind event_kind)
	ServiceEvent (IsolateGroup *isolate_group, EventKind event_kind)
	ServiceEvent (Isolate *isolate, EventKind event_kind)
Isolate *	isolate () const
IsolateGroup *	isolate_group () const
Dart_Port	isolate_id () const
EventKind	kind () const
bool	IsPause () const
const char *	flag_name () const
void	set_flag_name (const char *flag)
const char *	flag_new_value () const
void	set_flag_new_value (const char *value)
const char *	previous_tag () const
void	set_previous_tag (const char *previous_tag)
const char *	updated_tag () const
void	set_updated_tag (const char *updated_tag)
const char *	embedder_kind () const
const char *	KindAsCString () const
void	set_embedder_kind (const char *embedder_kind)
const StreamInfo *	stream_info () const
const char *	stream_id () const
void	set_embedder_stream_id (const char *stream_id)
Breakpoint *	breakpoint () const
void	set_breakpoint (Breakpoint *bpt)
ActivationFrame *	top_frame () const
void	set_top_frame (ActivationFrame *frame)
const String *	extension_rpc () const
void	set_extension_rpc (const String *extension_rpc)
const Object *	exception () const
void	set_exception (const Object *exception)
const Error *	reload_error () const
void	set_reload_error (const Error *error)
bool	at_async_jump () const
void	set_at_async_jump (bool value)
const Object *	inspectee () const
void	set_inspectee (const Object *inspectee)
const Heap::GCStats *	gc_stats () const
void	set_gc_stats (const Heap::GCStats *gc_stats)
const uint8_t *	bytes () const
intptr_t	bytes_length () const
void	set_bytes (const uint8_t *bytes, intptr_t bytes_length)
void	set_log_record (const LogRecord &log_record)
void	set_extension_event (const ExtensionEvent &extension_event)
void	UpdateTimestamp ()
int64_t	timestamp () const
const TimelineEventBlock *	timeline_event_block () const
void	set_timeline_event_block (const TimelineEventBlock *block)
Profile *	cpu_profile () const
void	set_cpu_profile (Profile *profile)
void	PrintJSON (JSONStream *js) const
void	PrintJSONHeader (JSONObject *jsobj) const

Detailed Description

Definition at line 24 of file service_event.h.

Member Enumeration Documentation

EventKind

enum dart::ServiceEvent::EventKind

Enumerator
kVMUpdate
kVMFlagUpdate
kIsolateStart
kIsolateRunnable
kIsolateExit
kIsolateUpdate
kIsolateReload
kServiceExtensionAdded
kPauseStart
kPauseExit
kPauseBreakpoint
kPauseInterrupted
kPauseException
kPausePostRequest
kNone
kResume
kBreakpointAdded
kBreakpointResolved
kBreakpointRemoved
kBreakpointUpdated
kInspect
kDebuggerSettingsUpdate
kGC
kEmbedder
kLogging
kExtension
kTimelineEvents
kTimelineStreamSubscriptionsUpdate
kUserTagChanged
kCpuSamples
kIllegal

Definition at line 26 of file service_event.h.

                 {
    kVMUpdate,      // VM identity information has changed
    kVMFlagUpdate,  // VM flags updated
 
    kIsolateStart,           // New isolate has started
    kIsolateRunnable,        // Isolate is ready to run
    kIsolateExit,            // Isolate has exited
    kIsolateUpdate,          // Isolate identity information has changed
    kIsolateReload,          // Result of a reload request
    kServiceExtensionAdded,  // A service extension was registered
 
    kPauseStart,  // --pause-isolates-on-start
    kPauseExit,   // --pause-isolates-on-exit
    kPauseBreakpoint,
    kPauseInterrupted,
    kPauseException,
    kPausePostRequest,  // isolate is paused after a service request.
    kNone,              // isolate has not been made runnable yet.
    kResume,
    kBreakpointAdded,
    kBreakpointResolved,
    kBreakpointRemoved,
    kBreakpointUpdated,
    kInspect,
    kDebuggerSettingsUpdate,
 
    kGC,
 
    kEmbedder,
 
    kLogging,
 
    kExtension,
 
    kTimelineEvents,
    // Sent when SetVMTimelineFlags is called.
    kTimelineStreamSubscriptionsUpdate,
 
    kUserTagChanged,
 
    kCpuSamples,
 
    kIllegal,
  };

Constructor & Destructor Documentation

ServiceEvent() [1/3]

dart::ServiceEvent::ServiceEvent ( EventKind  event_kind )

explicit

Definition at line 16 of file service_event.cc.

    : ServiceEvent(nullptr, nullptr, event_kind) {}

ServiceEvent() [2/3]

dart::ServiceEvent::ServiceEvent	(	IsolateGroup *	isolate_group,
		EventKind	event_kind
	)

Definition at line 19 of file service_event.cc.

    : ServiceEvent(isolate_group, nullptr, event_kind) {}

ServiceEvent() [3/3]

dart::ServiceEvent::ServiceEvent	(	Isolate *	isolate,
		EventKind	event_kind
	)

Definition at line 22 of file service_event.cc.

    : ServiceEvent(isolate != nullptr ? isolate->group() : nullptr,
                   isolate,
                   event_kind) {}

Member Function Documentation

at_async_jump()

bool dart::ServiceEvent::at_async_jump ( ) const

inline

Definition at line 178 of file service_event.h.

{ return at_async_jump_; }

breakpoint()

Breakpoint * dart::ServiceEvent::breakpoint ( ) const

inline

Definition at line 142 of file service_event.h.

{ return breakpoint_; }

bytes()

const uint8_t * dart::ServiceEvent::bytes ( ) const

inline

Definition at line 191 of file service_event.h.

{ return bytes_; }

bytes_length()

intptr_t dart::ServiceEvent::bytes_length ( ) const

inline

Definition at line 193 of file service_event.h.

{ return bytes_length_; }

cpu_profile()

Profile * dart::ServiceEvent::cpu_profile ( ) const

inline

Definition at line 219 of file service_event.h.

{ return cpu_profile_; }

embedder_kind()

const char * dart::ServiceEvent::embedder_kind ( ) const

inline

Definition at line 127 of file service_event.h.

{ return embedder_kind_; }

exception()

const Object * dart::ServiceEvent::exception ( ) const

inline

Definition at line 163 of file service_event.h.

{ return exception_; }

extension_rpc()

const String * dart::ServiceEvent::extension_rpc ( ) const

inline

Definition at line 158 of file service_event.h.

{ return extension_rpc_; }

flag_name()

const char * dart::ServiceEvent::flag_name ( ) const

inline

Definition at line 113 of file service_event.h.

{ return flag_name_; }

flag_new_value()

const char * dart::ServiceEvent::flag_new_value ( ) const

inline

Definition at line 116 of file service_event.h.

{ return flag_new_value_; }

gc_stats()

const Heap::GCStats * dart::ServiceEvent::gc_stats ( ) const

inline

Definition at line 187 of file service_event.h.

{ return gc_stats_; }

inspectee()

const Object * dart::ServiceEvent::inspectee ( ) const

inline

Definition at line 181 of file service_event.h.

{ return inspectee_; }

isolate()

Isolate * dart::ServiceEvent::isolate ( ) const

inline

Definition at line 91 of file service_event.h.

{ return isolate_; }

isolate_group()

IsolateGroup * dart::ServiceEvent::isolate_group ( ) const

inline

Definition at line 92 of file service_event.h.

{ return isolate_group_; }

isolate_id()

Dart_Port dart::ServiceEvent::isolate_id ( ) const

inline

Definition at line 95 of file service_event.h.

{ return isolate_->main_port(); }

IsPause()

bool dart::ServiceEvent::IsPause ( ) const

inline

Definition at line 99 of file service_event.h.

                       {
    switch (kind()) {
      case kPauseStart:
      case kPauseExit:
      case kPauseBreakpoint:
      case kPauseInterrupted:
      case kPauseException:
      case kPausePostRequest:
        return true;
      default:
        return false;
    }
  }

kind()

EventKind dart::ServiceEvent::kind ( ) const

inline

Definition at line 97 of file service_event.h.

{ return kind_; }

KindAsCString()

const char * dart::ServiceEvent::KindAsCString

(

)

const

Definition at line 85 of file service_event.cc.

                                              {
  switch (kind()) {
    case kVMUpdate:
      return "VMUpdate";
    case kVMFlagUpdate:
      return "VMFlagUpdate";
    case kIsolateStart:
      return "IsolateStart";
    case kIsolateRunnable:
      return "IsolateRunnable";
    case kIsolateExit:
      return "IsolateExit";
    case kIsolateUpdate:
      return "IsolateUpdate";
    case kServiceExtensionAdded:
      return "ServiceExtensionAdded";
    case kIsolateReload:
      return "IsolateReload";
    case kPauseStart:
      return "PauseStart";
    case kPauseExit:
      return "PauseExit";
    case kPauseBreakpoint:
      return "PauseBreakpoint";
    case kPauseInterrupted:
      return "PauseInterrupted";
    case kPauseException:
      return "PauseException";
    case kPausePostRequest:
      return "PausePostRequest";
    case kNone:
      return "None";
    case kResume:
      return "Resume";
    case kBreakpointAdded:
      return "BreakpointAdded";
    case kBreakpointResolved:
      return "BreakpointResolved";
    case kBreakpointRemoved:
      return "BreakpointRemoved";
    case kBreakpointUpdated:
      return "BreakpointUpdated";
    case kGC:
      return "GC";  // TODO(koda): Change to GarbageCollected.
    case kInspect:
      return "Inspect";
    case kEmbedder:
      return embedder_kind();
    case kLogging:
      return "Logging";
    case kDebuggerSettingsUpdate:
      return "_DebuggerSettingsUpdate";
    case kIllegal:
      return "Illegal";
    case kExtension:
      return "Extension";
    case kTimelineEvents:
      return "TimelineEvents";
    case kTimelineStreamSubscriptionsUpdate:
      return "TimelineStreamSubscriptionsUpdate";
    case kUserTagChanged:
      return "UserTagChanged";
    case kCpuSamples:
      return "CpuSamples";
    default:
      UNREACHABLE();
      return "Unknown";
  }
}

previous_tag()

const char * dart::ServiceEvent::previous_tag ( ) const

inline

Definition at line 119 of file service_event.h.

{ return previous_tag_; }

PrintJSON()

void dart::ServiceEvent::PrintJSON

(

JSONStream *

js

)

const

Definition at line 221 of file service_event.cc.

                                                 {
  JSONObject jsobj(js);
  PrintJSONHeader(&jsobj);
  if (kind() == kVMFlagUpdate) {
    jsobj.AddProperty("flag", flag_name());
    // For backwards compatibility, "new_value" is also provided.
    jsobj.AddProperty("newValue", flag_new_value());
  }
  if (kind() == kUserTagChanged) {
    jsobj.AddProperty("previousTag", previous_tag());
    jsobj.AddProperty("updatedTag", updated_tag());
  }
  if (kind() == kIsolateReload) {
    if (reload_error_ == nullptr) {
      jsobj.AddProperty("status", "success");
    } else {
      jsobj.AddProperty("status", "failure");
      jsobj.AddProperty("reloadError", *(reload_error()));
    }
  }
  if (kind() == kServiceExtensionAdded) {
    ASSERT(extension_rpc_ != nullptr);
    jsobj.AddProperty("extensionRPC", extension_rpc_->ToCString());
  }
  if (kind() == kPauseBreakpoint) {
    JSONArray jsarr(&jsobj, "pauseBreakpoints");
    // TODO(rmacnak): If we are paused at more than one breakpoint,
    // provide it here.
    if (breakpoint() != nullptr) {
      jsarr.AddValue(breakpoint());
    }
  } else {
    if (breakpoint() != nullptr) {
      jsobj.AddProperty("breakpoint", breakpoint());
    }
  }
  if (kind() == kTimelineEvents) {
    jsobj.AddProperty("timelineEvents", timeline_event_block_);
  }
  if (kind() == kTimelineStreamSubscriptionsUpdate) {
    JSONArray arr(&jsobj, "updatedStreams");
    Timeline::PrintFlagsToJSONArray(&arr);
  }
  if (kind() == kDebuggerSettingsUpdate) {
    JSONObject jssettings(&jsobj, "_debuggerSettings");
    isolate()->debugger()->PrintSettingsToJSONObject(&jssettings);
  }
#if !defined(DART_PRECOMPILED_RUNTIME)
  if (top_frame() != nullptr) {
    JSONObject jsFrame(&jsobj, "topFrame");
    top_frame()->PrintToJSONObject(&jsFrame);
    intptr_t index = 0;  // Avoid ambiguity in call to AddProperty.
    jsFrame.AddProperty("index", index);
  }
#endif
  if (exception() != nullptr) {
    jsobj.AddProperty("exception", *(exception()));
  }
  if (at_async_jump()) {
    jsobj.AddProperty("atAsyncSuspension", true);
  }
  if (inspectee() != nullptr) {
    jsobj.AddProperty("inspectee", *(inspectee()));
  }
  if (gc_stats() != nullptr) {
    jsobj.AddProperty("reason", Heap::GCReasonToString(gc_stats()->reason_));
    jsobj.AddProperty("gcType", Heap::GCTypeToString(gc_stats()->type_));
    isolate_group()->heap()->PrintToJSONObject(Heap::kNew, &jsobj);
    isolate_group()->heap()->PrintToJSONObject(Heap::kOld, &jsobj);
  }
  if (bytes() != nullptr) {
    jsobj.AddPropertyBase64("bytes", bytes(), bytes_length());
  }
  if (kind() == kLogging) {
    JSONObject logRecord(&jsobj, "logRecord");
    logRecord.AddProperty("type", "LogRecord");
    logRecord.AddProperty64("sequenceNumber", log_record_.sequence_number);
    logRecord.AddPropertyTimeMillis("time", log_record_.timestamp);
    logRecord.AddProperty64("level", log_record_.level);
    logRecord.AddProperty("loggerName", *(log_record_.name));
    logRecord.AddProperty("message", *(log_record_.message));
    logRecord.AddProperty("zone", *(log_record_.zone));
    logRecord.AddProperty("error", *(log_record_.error));
    logRecord.AddProperty("stackTrace", *(log_record_.stack_trace));
  }
  if (kind() == kExtension) {
    js->AppendSerializedObject("extensionData",
                               extension_event_.event_data->ToCString());
  }
 
  if (kind() == kCpuSamples) {
    JSONObject cpu_profile(&jsobj, "cpuSamples");
    cpu_profile_->PrintProfileJSON(&cpu_profile, /*include_code_samples=*/false,
                                   /*is_event=*/true);
  }
}

PrintJSONHeader()

void dart::ServiceEvent::PrintJSONHeader

(

JSONObject *

jsobj

)

const

Definition at line 318 of file service_event.cc.

                                                          {
  ASSERT(jsobj != nullptr);
  jsobj->AddProperty("type", "Event");
  jsobj->AddProperty("kind", KindAsCString());
  if (kind() == kExtension) {
    ASSERT(extension_event_.event_kind != nullptr);
    jsobj->AddProperty("extensionKind",
                       extension_event_.event_kind->ToCString());
  }
  if (isolate_group() != nullptr) {
    jsobj->AddProperty("isolateGroup", isolate_group());
  }
  if (isolate() != nullptr) {
    ASSERT(isolate_group() != nullptr);
    jsobj->AddProperty("isolate", isolate());
  }
  if (isolate_group() == nullptr && isolate() == nullptr) {
    jsobj->AddPropertyVM("vm");
  }
  ASSERT(timestamp_ != -1);
  jsobj->AddPropertyTimeMillis("timestamp", timestamp_);
}

reload_error()

const Error * dart::ServiceEvent::reload_error ( ) const

inline

Definition at line 169 of file service_event.h.

                                    {
    ASSERT(kind_ == kIsolateReload);
    return reload_error_;
  }

set_at_async_jump()

void dart::ServiceEvent::set_at_async_jump ( bool  value )

inline

Definition at line 179 of file service_event.h.

{ at_async_jump_ = value; }

set_breakpoint()

void dart::ServiceEvent::set_breakpoint ( Breakpoint *  bpt )

inline

Definition at line 143 of file service_event.h.

                                       {
    ASSERT(kind() == kPauseBreakpoint || kind() == kBreakpointAdded ||
           kind() == kBreakpointResolved || kind() == kBreakpointRemoved ||
           kind() == kBreakpointUpdated);
    breakpoint_ = bpt;
  }

set_bytes()

void dart::ServiceEvent::set_bytes ( const uint8_t *  bytes, intptr_t  bytes_length  )

inline

Definition at line 195 of file service_event.h.

                                                              {
    bytes_ = bytes;
    bytes_length_ = bytes_length;
  }

set_cpu_profile()

void dart::ServiceEvent::set_cpu_profile ( Profile *  profile )

inline

Definition at line 220 of file service_event.h.

{ cpu_profile_ = profile; }

set_embedder_kind()

void dart::ServiceEvent::set_embedder_kind ( const char *  embedder_kind )

inline

Definition at line 131 of file service_event.h.

                                                    {
    embedder_kind_ = embedder_kind;
  }

set_embedder_stream_id()

void dart::ServiceEvent::set_embedder_stream_id ( const char *  stream_id )

inline

Definition at line 138 of file service_event.h.

                                                     {
    embedder_stream_id_ = stream_id;
  }

set_exception()

void dart::ServiceEvent::set_exception ( const Object *  exception )

inline

Definition at line 164 of file service_event.h.

                                              {
    ASSERT(kind_ == kPauseException);
    exception_ = exception;
  }

set_extension_event()

void dart::ServiceEvent::set_extension_event ( const ExtensionEvent &  extension_event )

inline

Definition at line 202 of file service_event.h.

                                                                  {
    extension_event_ = extension_event;
  }

set_extension_rpc()

void dart::ServiceEvent::set_extension_rpc ( const String *  extension_rpc )

inline

Definition at line 159 of file service_event.h.

                                                      {
    extension_rpc_ = extension_rpc;
  }

set_flag_name()

void dart::ServiceEvent::set_flag_name ( const char *  flag )

inline

Definition at line 114 of file service_event.h.

{ flag_name_ = flag; }

set_flag_new_value()

void dart::ServiceEvent::set_flag_new_value ( const char *  value )

inline

Definition at line 117 of file service_event.h.

{ flag_new_value_ = value; }

set_gc_stats()

void dart::ServiceEvent::set_gc_stats ( const Heap::GCStats *  gc_stats )

inline

Definition at line 189 of file service_event.h.

{ gc_stats_ = gc_stats; }

set_inspectee()

void dart::ServiceEvent::set_inspectee ( const Object *  inspectee )

inline

Definition at line 182 of file service_event.h.

                                              {
    ASSERT(kind_ == kInspect);
    inspectee_ = inspectee;
  }

set_log_record()

void dart::ServiceEvent::set_log_record ( const LogRecord &  log_record )

inline

Definition at line 200 of file service_event.h.

{ log_record_ = log_record; }

set_previous_tag()

void dart::ServiceEvent::set_previous_tag ( const char *  previous_tag )

inline

Definition at line 120 of file service_event.h.

                                                  {
    previous_tag_ = previous_tag;
  }

set_reload_error()

void dart::ServiceEvent::set_reload_error ( const Error *  error )

inline

Definition at line 173 of file service_event.h.

                                            {
    ASSERT(kind_ == kIsolateReload);
    reload_error_ = error;
  }

set_timeline_event_block()

void dart::ServiceEvent::set_timeline_event_block ( const TimelineEventBlock *  block )

inline

Definition at line 214 of file service_event.h.

                                                                 {
    ASSERT(kind() == kTimelineEvents);
    timeline_event_block_ = block;
  }

set_top_frame()

void dart::ServiceEvent::set_top_frame ( ActivationFrame *  frame )

inline

Definition at line 151 of file service_event.h.

                                             {
    ASSERT(kind() == kPauseBreakpoint || kind() == kPauseInterrupted ||
           kind() == kPauseException || kind() == kPausePostRequest ||
           kind() == kResume);
    top_frame_ = frame;
  }

set_updated_tag()

void dart::ServiceEvent::set_updated_tag ( const char *  updated_tag )

inline

Definition at line 125 of file service_event.h.

{ updated_tag_ = updated_tag; }

stream_id()

const char * dart::ServiceEvent::stream_id

(

)

const

Definition at line 211 of file service_event.cc.

                                          {
  const StreamInfo* stream = stream_info();
  if (stream == nullptr) {
    ASSERT(kind() == kEmbedder);
    return embedder_stream_id_;
  } else {
    return stream->id();
  }
}

stream_info()

const StreamInfo * dart::ServiceEvent::stream_info

(

)

const

Definition at line 155 of file service_event.cc.

                                                  {
  switch (kind()) {
    case kVMUpdate:
    case kVMFlagUpdate:
      return &Service::vm_stream;
 
    case kIsolateStart:
    case kIsolateRunnable:
    case kIsolateExit:
    case kIsolateUpdate:
    case kIsolateReload:
    case kServiceExtensionAdded:
      return &Service::isolate_stream;
 
    case kPauseStart:
    case kPauseExit:
    case kPauseBreakpoint:
    case kPauseInterrupted:
    case kPauseException:
    case kPausePostRequest:
    case kNone:
    case kResume:
    case kBreakpointAdded:
    case kBreakpointResolved:
    case kBreakpointRemoved:
    case kBreakpointUpdated:
    case kInspect:
    case kDebuggerSettingsUpdate:
      return &Service::debug_stream;
 
    case kGC:
      return &Service::gc_stream;
 
    case kLogging:
      return &Service::logging_stream;
 
    case kExtension:
      return &Service::extension_stream;
 
    case kTimelineEvents:
    case kTimelineStreamSubscriptionsUpdate:
      return &Service::timeline_stream;
 
    case kEmbedder:
      return nullptr;
 
    case kCpuSamples:
    case kUserTagChanged:
      return &Service::profiler_stream;
 
    default:
      UNREACHABLE();
      return nullptr;
  }
}

timeline_event_block()

const TimelineEventBlock * dart::ServiceEvent::timeline_event_block ( ) const

inline

Definition at line 210 of file service_event.h.

                                                         {
    return timeline_event_block_;
  }

timestamp()

int64_t dart::ServiceEvent::timestamp ( ) const

inline

Definition at line 208 of file service_event.h.

{ return timestamp_; }

top_frame()

ActivationFrame * dart::ServiceEvent::top_frame ( ) const

inline

Definition at line 150 of file service_event.h.

{ return top_frame_; }

updated_tag()

const char * dart::ServiceEvent::updated_tag ( ) const

inline

Definition at line 124 of file service_event.h.

{ return updated_tag_; }

UpdateTimestamp()

void dart::ServiceEvent::UpdateTimestamp

(

)

Definition at line 81 of file service_event.cc.

                                   {
  timestamp_ = OS::GetCurrentTimeMillis();
}

---

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

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