Support piping log data over the service protocol

runtime/vm/service.cc

 // Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 #include "vm/service.h"
 
 #include "include/dart_api.h"
 #include "include/dart_native_api.h"
 #include "platform/globals.h"
 
@@ skipping 69 matching lines @@
 Dart_ServiceStreamListenCallback Service::stream_listen_callback_ = NULL;
 Dart_ServiceStreamCancelCallback Service::stream_cancel_callback_ = NULL;
 
 
 // These are the set of streams known to the core VM.
 StreamInfo Service::isolate_stream("Isolate");
 StreamInfo Service::debug_stream("Debug");
 StreamInfo Service::gc_stream("GC");
 StreamInfo Service::echo_stream("_Echo");
 StreamInfo Service::graph_stream("_Graph");
-
+StreamInfo Service::logging_stream("Logging");
 
 static StreamInfo* streams_[] = {
   &Service::isolate_stream,
   &Service::debug_stream,
   &Service::gc_stream,
   &Service::echo_stream,
   &Service::graph_stream,
+  &Service::logging_stream,
 };
 
 
 bool Service::ListenStream(const char* stream_id) {
   if (FLAG_trace_service) {
     OS::Print("vm-service: starting stream '%s'\n",
               stream_id);
   }
   intptr_t num_streams = sizeof(streams_) /
                          sizeof(streams_[0]);
@@ skipping 568 matching lines @@
     return;
   }
   JSONStream js;
   const char* stream_id = event->stream_id();
   ASSERT(stream_id != NULL);
   {
     JSONObject jsobj(&js);
     jsobj.AddProperty("event", event);
     jsobj.AddProperty("streamId", stream_id);
   }
+  PostEvent(stream_id, event->KindAsCString(), &js);
+}
+
+
+void Service::PostEvent(const char* stream_id,
+                        const char* kind,
+                        JSONStream* event) {
+  ASSERT(stream_id != NULL);
+  ASSERT(kind != NULL);
+  ASSERT(event != NULL);
 
   // Message is of the format [<stream id>, <json string>].
   //
   // Build the event message in the C heap to avoid dart heap
   // allocation.  This method can be called while we have acquired a
   // direct pointer to typed data, so we can't allocate here.
   Dart_CObject list_cobj;
   Dart_CObject* list_values[2];
   list_cobj.type = Dart_CObject_kArray;
   list_cobj.value.as_array.length = 2;
   list_cobj.value.as_array.values = list_values;
 
   Dart_CObject stream_id_cobj;
   stream_id_cobj.type = Dart_CObject_kString;
   stream_id_cobj.value.as_string = const_cast<char*>(stream_id);
   list_values[0] = &stream_id_cobj;
 
   Dart_CObject json_cobj;
   json_cobj.type = Dart_CObject_kString;
-  json_cobj.value.as_string = const_cast<char*>(js.ToCString());
+  json_cobj.value.as_string = const_cast<char*>(event->ToCString());
   list_values[1] = &json_cobj;
 
   if (FLAG_trace_service) {
     OS::Print(
-        "vm-service: Pushing event of type %s to stream %s\n",
-        event->KindAsCString(), stream_id);
+        "vm-service: Pushing event of type %s to stream %s\n", kind, stream_id);
   }
 
   Dart_PostCObject(ServiceIsolate::Port(), &list_cobj);
 }
 
 
 class EmbedderServiceHandler {
  public:
   explicit EmbedderServiceHandler(const char* name) : name_(NULL),
                                                       callback_(NULL),
@@ skipping 1783 matching lines @@
     return;
   }
   ServiceEvent event(isolate, ServiceEvent::kEmbedder);
   event.set_embedder_kind(event_kind);
   event.set_embedder_stream_id(stream_id);
   event.set_bytes(bytes, bytes_len);
   Service::HandleEvent(&event);
 }
 
 
+void Service::SendLogEvent(Isolate* isolate,
+                           int64_t sequence_number,
+                           int64_t timestamp,
+
+                           intptr_t level,
+                           const String& name,
+                           const String& message,
+                           const Instance& zone,
+                           const Object& error,
+                           const Instance& stack_trace) {

[turnidge, 2015/07/17 00:19:55]

Can this work like most of the other ServiceEvents?  For those we add the data
to the ServiceEvent object and then the ServiceEvent knows how to print itself
as json.

I know there are a few exceptions, but they are old.

[Cutch, 2015/07/17 00:50:13]

I deliberately didn't make this work like the other ServiceEvents. My reasoning
was that in order to do that we need to allocate 4 extra handles and bloat the
ServiceEvent with 8 fields. That felt wasteful and I decided instead to refactor
the code so that the practically all of the code is shared.

+  ServiceEvent service_event(isolate, ServiceEvent::kLogging);
+  JSONStream js;
+  const char* stream_id = service_event.stream_id();
+  ASSERT(stream_id != NULL);
+  {
+    JSONObject jsobj(&js);
+    jsobj.AddProperty("streamId", stream_id);
+    {
+      JSONObject event(&jsobj, "event");
+      // Print header.
+      service_event.PrintJSONHeader(&event);
+      {
+        JSONObject logRecord(&event, "logRecord");
+        event.AddProperty64("sequenceNumber", sequence_number);
+        event.AddPropertyTimeMillis("time", timestamp);
+        event.AddProperty64("level", level);
+        event.AddProperty("loggerName", name);
+        event.AddProperty("message", message);
+        event.AddProperty("zone", zone);
+        event.AddProperty("error", error);
+        event.AddProperty("stackTrace", stack_trace);

[turnidge, 2015/07/17 00:19:54]

This stuff would move into the ServiceEvent::PrintJSON or whatever it is called.

[Cutch, 2015/07/17 00:50:13]

Acknowledged.

+      }
+    }
+  }
+  Service::PostEvent(stream_id, service_event.KindAsCString(), &js);
+}
+
+
 class ContainsAddressVisitor : public FindObjectVisitor {
  public:
   ContainsAddressVisitor(Isolate* isolate, uword addr)
       : FindObjectVisitor(isolate), addr_(addr) { }
   virtual ~ContainsAddressVisitor() { }
 
   virtual uword filter_addr() const { return addr_; }
 
   virtual bool FindObject(RawObject* obj) const {
     // Free list elements are not real objects, so skip them.
@@ skipping 489 matching lines @@
     ServiceMethodDescriptor& method = service_methods_[i];
     if (strcmp(method_name, method.name) == 0) {
       return &method;
     }
   }
   return NULL;
 }
 
 
 }  // namespace dart