Add Service ID zones to 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 "platform/globals.h"
 
 #include "vm/compiler.h"
@@ skipping 21 matching lines @@
 #include "vm/stack_frame.h"
 #include "vm/symbols.h"
 #include "vm/unicode.h"
 #include "vm/version.h"
 
 namespace dart {
 
 DECLARE_FLAG(bool, trace_service);
 DECLARE_FLAG(bool, trace_service_pause_events);
 
+ServiceIdZone::ServiceIdZone() {
+}
+
+
+ServiceIdZone::~ServiceIdZone() {
+}
+
+
+RingServiceIdZone::RingServiceIdZone(ObjectIdRing::IdPolicy policy)
+    : policy_(policy) {
+}
+
+
+RingServiceIdZone::~RingServiceIdZone() {
+}
+
+
+char* RingServiceIdZone::GetServiceId(const Object& obj) {
+  Thread* thread = Thread::Current();
+  Isolate* isolate = thread->isolate();
+  ASSERT(isolate != NULL);
+  Zone* zone = thread->zone();
+  ASSERT(zone != NULL);
+  ObjectIdRing* ring = isolate->object_id_ring();
+  const intptr_t id = ring->GetIdForObject(obj.raw(), policy_);
+  return zone->PrintToString("objects/%" Pd "", id);
+}
+
+
 // TODO(johnmccutchan): Unify embedder service handler lists and their APIs.
 EmbedderServiceHandler* Service::isolate_service_handler_head_ = NULL;
 EmbedderServiceHandler* Service::root_service_handler_head_ = NULL;
 struct ServiceMethodDescriptor;
 ServiceMethodDescriptor* FindMethod(const char* method_name);
 
 static uint8_t* allocator(uint8_t* ptr, intptr_t old_size, intptr_t new_size) {
   void* new_ptr = realloc(reinterpret_cast<void*>(ptr), new_size);
   return reinterpret_cast<uint8_t*>(new_ptr);
 }
@@ skipping 391 matching lines @@
     ASSERT(param_keys.Length() == param_values.Length());
 
     if (!reply_port.IsSendPort()) {
       FATAL("SendPort expected.");
     }
 
     JSONStream js;
     js.Setup(zone.GetZone(), SendPort::Cast(reply_port).Id(),
              seq, method_name, param_keys, param_values);
 
+    // RPC came in with a custom service id zone.
+    const char* id_zone_param = js.LookupParam("_idZone");
+
+    if (id_zone_param != NULL) {
+      // Override id zone.
+      if (strcmp("default", id_zone_param) == 0) {
+        // Ring with eager id allocation. This is the default ring and default
+        // policy.
+        // Nothing to do.
+      } else if (strcmp("default.reuse", id_zone_param) == 0) {
+        // Change the default ring's policy.
+        RingServiceIdZone* zone =
+            reinterpret_cast<RingServiceIdZone*>(js.id_zone());
+        zone->set_policy(ObjectIdRing::kReuseId);
+      } else {
+        // TODO(johnmccutchan): Support creating, deleting, and selecting
+        // custom service id zones.
+        // For now, always return an error.
+        PrintInvalidParamError(&js, "_idZone");
+        js.PostReply();
+        return;
+      }
+    }
     const char* c_method_name = method_name.ToCString();
 
     ServiceMethodDescriptor* method = FindMethod(c_method_name);
     if (method != NULL) {
       if (!ValidateParameters(method->parameters, &js)) {
         js.PostReply();
         return;
       }
       if (method->entry(isolate, &js)) {
         js.PostReply();
@@ skipping 249 matching lines @@
 
 
 static bool GetIsolate(Isolate* isolate, JSONStream* js) {
   isolate->PrintJSON(js, false);
   return true;
 }
 
 
 static const MethodParameter* get_stack_params[] = {
   ISOLATE_PARAMETER,
-  new BoolParameter("full", false),
+  new BoolParameter("_full", false),
   NULL,
 };
 
 
 static bool GetStack(Isolate* isolate, JSONStream* js) {
   DebuggerStackTrace* stack = isolate->debugger()->StackTrace();
   // Do we want the complete script object and complete local variable objects?
   // This is true for dump requests.
-  const bool full = BoolParameter::Parse(js->LookupParam("full"), false);
+  const bool full = BoolParameter::Parse(js->LookupParam("_full"), false);
   JSONObject jsobj(js);
   jsobj.AddProperty("type", "Stack");
   {
     JSONArray jsarr(&jsobj, "frames");
 
     intptr_t num_frames = stack->Length();
     for (intptr_t i = 0; i < num_frames; i++) {
       ActivationFrame* frame = stack->FrameAt(i);
       JSONObject jsobj(&jsarr);
       frame->PrintToJSONObject(&jsobj, full);
@@ skipping 35 matching lines @@
         event.AddProperty("text", text);
       }
     }
   }
   const String& message = String::Handle(String::New(js.ToCString()));
   uint8_t data[] = {0, 128, 255};
   SendEvent(message, data, sizeof(data));
 }
 
 
-static bool _TriggerEchoEvent(Isolate* isolate, JSONStream* js) {
+static bool TriggerEchoEvent(Isolate* isolate, JSONStream* js) {
   Service::SendEchoEvent(isolate, js->LookupParam("text"));
   JSONObject jsobj(js);
   return HandleCommonEcho(&jsobj, js);
 }
 
 
-static bool _Echo(Isolate* isolate, JSONStream* js) {
+static bool DumpIdZone(Isolate* isolate, JSONStream* js) {
+  // TODO(johnmccutchan): Respect _idZone parameter passed to RPC. For now,
+  // always send the ObjectIdRing.
+  //
+
+  // When printing the ObjectIdRing, force object id reuse policy.
+  RingServiceIdZone reuse_zone(ObjectIdRing::kReuseId);
+  js->set_id_zone(&reuse_zone);
+
+  ObjectIdRing* ring = isolate->object_id_ring();
+  ring->PrintJSON(js);
+  return true;
+}
+
+
+static bool Echo(Isolate* isolate, JSONStream* js) {
   JSONObject jsobj(js);
   return HandleCommonEcho(&jsobj, js);
 }
 
 
 static bool ContainsNonInstance(const Object& obj) {
   if (obj.IsArray()) {
     const Array& array = Array::Cast(obj);
     Object& element = Object::Handle();
     for (intptr_t i = 0; i < array.Length(); ++i) {
@@ skipping 1506 matching lines @@
   }
   if (object.IsNull()) {
     PrintSentinel(js, "objects/free", "<free>");
   } else {
     object.PrintJSON(js, ref);
   }
   return true;
 }
 
 
-static bool _RespondWithMalformedJson(Isolate* isolate,
+static bool RespondWithMalformedJson(Isolate* isolate,
                                       JSONStream* js) {
   JSONObject jsobj(js);
   jsobj.AddProperty("a", "a");
   JSONObject jsobj1(js);
   jsobj1.AddProperty("a", "a");
   JSONObject jsobj2(js);
   jsobj2.AddProperty("a", "a");
   JSONObject jsobj3(js);
   jsobj3.AddProperty("a", "a");
   return true;
 }
 
 
-static bool _RespondWithMalformedObject(Isolate* isolate,
+static bool RespondWithMalformedObject(Isolate* isolate,
                                         JSONStream* js) {
   JSONObject jsobj(js);
   jsobj.AddProperty("bart", "simpson");
   return true;
 }
 
 
 static const MethodParameter* get_object_params[] = {
   ISOLATE_PARAMETER,
   NULL,
@@ skipping 194 matching lines @@
     ServiceEvent event(isolate, ServiceEvent::kIsolateUpdate);
     Service::HandleEvent(&event);
   }
   JSONObject jsobj(js);
   jsobj.AddProperty("type", "Success");
   return true;
 }
 
 
 static ServiceMethodDescriptor service_methods_[] = {
-  { "_echo", _Echo,
+  { "_dumpIdZone", DumpIdZone, NULL },
+  { "_echo", Echo,
     NULL },
-  { "_respondWithMalformedJson", _RespondWithMalformedJson,
+  { "_respondWithMalformedJson", RespondWithMalformedJson,
     NULL },
-  { "_respondWithMalformedObject", _RespondWithMalformedObject,
+  { "_respondWithMalformedObject", RespondWithMalformedObject,
     NULL },
-  { "_triggerEchoEvent", _TriggerEchoEvent,
+  { "_triggerEchoEvent", TriggerEchoEvent,
     NULL },
   { "addBreakpoint", AddBreakpoint,
     add_breakpoint_params },
   { "addBreakpointAtEntry", AddBreakpointAtEntry,
     add_breakpoint_at_entry_params },
   { "clearCpuProfile", ClearCpuProfile,
     clear_cpu_profile_params },
   { "eval", Eval,
     eval_params },
   { "evalFrame", EvalFrame,
@@ skipping 64 matching lines @@
     ServiceMethodDescriptor& method = service_methods_[i];
     if (strcmp(method_name, method.name) == 0) {
       return &method;
     }
   }
   return NULL;
 }
 
 
 }  // namespace dart