Add Service ID zones to service protocol

runtime/vm/object.cc

 // Copyright (c) 2012, 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/object.h"
 
 #include "include/dart_api.h"
 #include "platform/assert.h"
 #include "vm/assembler.h"
 #include "vm/cpu.h"
@@ skipping 14 matching lines @@
 #include "vm/disassembler.h"
 #include "vm/double_conversion.h"
 #include "vm/exceptions.h"
 #include "vm/flow_graph_builder.h"
 #include "vm/flow_graph_compiler.h"
 #include "vm/growable_array.h"
 #include "vm/hash_table.h"
 #include "vm/heap.h"
 #include "vm/intermediate_language.h"
 #include "vm/intrinsifier.h"
-#include "vm/object_id_ring.h"
 #include "vm/object_store.h"
 #include "vm/parser.h"
 #include "vm/report.h"
 #include "vm/reusable_handles.h"
 #include "vm/runtime_entry.h"
 #include "vm/scopes.h"
 #include "vm/stack_frame.h"
 #include "vm/symbols.h"
 #include "vm/tags.h"
 #include "vm/timer.h"
@@ skipping 1544 matching lines @@
     }
   } else {
     PrintJSONImpl(stream, ref);
   }
 }
 
 
 void Object::PrintJSONImpl(JSONStream* stream, bool ref) const {
   JSONObject jsobj(stream);
   AddTypeProperties(&jsobj, "Object", JSONType(), ref);
-  ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-  const intptr_t id = ring->GetIdForObject(raw());
-  jsobj.AddPropertyF("id", "objects/%" Pd "", id);
+  jsobj.AddServiceId("id", *this);

[turnidge, 2015/05/11 19:48:45]

This is nicer.

   if (ref) {
     return;
   }
   Class& cls = Class::Handle(this->clazz());
   jsobj.AddProperty("class", cls);
   jsobj.AddProperty("size", raw()->Size());
 }
 
 
 RawString* Object::DictionaryName() const {
@@ skipping 2796 matching lines @@
 
 void TypeArguments::PrintJSONImpl(JSONStream* stream, bool ref) const {
   JSONObject jsobj(stream);
   // The index in the canonical_type_arguments table cannot be used as part of
   // the object id (as in typearguments/id), because the indices are not
   // preserved when the table grows and the entries get rehashed. Use the ring.
   Isolate* isolate = Isolate::Current();
   ObjectStore* object_store = isolate->object_store();
   const Array& table = Array::Handle(object_store->canonical_type_arguments());
   ASSERT(table.Length() > 0);
-  ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-  const intptr_t id = ring->GetIdForObject(raw());
   AddTypeProperties(&jsobj, "TypeArguments", JSONType(), ref);
-  jsobj.AddPropertyF("id", "objects/%" Pd "", id);
+  jsobj.AddServiceId("id", *this);
   const String& user_name = String::Handle(PrettyName());
   const String& vm_name = String::Handle(Name());
   AddNameProperties(&jsobj, user_name, vm_name);
   if (ref) {
     return;
   }
   {
     JSONArray jsarr(&jsobj, "types");
     AbstractType& type_arg = AbstractType::Handle();
     for (intptr_t i = 0; i < Length(); i++) {
@@ skipping 2365 matching lines @@
   const char* function_name = String::Handle(name()).ToCString();
   intptr_t len = OS::SNPrint(NULL, 0, kFormat, function_name,
                              static_str, abstract_str, kind_str, const_str) + 1;
   char* chars = Isolate::Current()->current_zone()->Alloc<char>(len);
   OS::SNPrint(chars, len, kFormat, function_name,
               static_str, abstract_str, kind_str, const_str);
   return chars;
 }
 
 
-static const char* GetFunctionServiceId(const Function& f, const Class& cls) {
-  Zone* zone = Isolate::Current()->current_zone();
+static void SetFunctionServiceId(const JSONObject& jsobj,

[turnidge, 2015/05/11 19:48:45]

AddFunctionServiceId or AddFunctionServiceIdProperty?

[Cutch, 2015/05/12 14:59:57]

Done.

+                                 const Function& f,
+                                 const Class& cls) {
   // Special kinds of functions use indices in their respective lists.
   intptr_t id = -1;
   const char* selector = NULL;
   if (f.IsNonImplicitClosureFunction()) {
     id = cls.FindClosureIndex(f);
     selector = "closures";
   } else if (f.IsImplicitClosureFunction()) {
     id = cls.FindImplicitClosureFunctionIndex(f);
     selector = "implicit_closures";
   } else if (f.IsNoSuchMethodDispatcher() || f.IsInvokeFieldDispatcher()) {
     id = cls.FindInvocationDispatcherFunctionIndex(f);
     selector = "dispatchers";
   }
   if (id != -1) {
     ASSERT(selector != NULL);
-    return zone->PrintToString("classes/%" Pd "/%s/%" Pd "",
-                               cls.id(), selector, id);
+    jsobj.AddPropertyF("id", "classes/%" Pd "/%s/%" Pd "",
+                              cls.id(), selector, id);
+    return;
   }
   // Regular functions known to their owner use their name (percent-encoded).
   String& name = String::Handle(f.name());
   if (cls.LookupFunction(name) == f.raw()) {
     name = String::EncodeIRI(name);
-    return zone->PrintToString("classes/%" Pd "/functions/%s",
-                               cls.id(), name.ToCString());
+    jsobj.AddPropertyF("id", "classes/%" Pd "/functions/%s",
+                              cls.id(), name.ToCString());
+    return;
   }
   // Oddball functions (not known to their owner) fall back to use the object
   // id ring. Current known examples are signature functions of closures
   // and stubs like 'megamorphic_miss'.
-  ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-  id = ring->GetIdForObject(f.raw());
-  return zone->PrintToString("objects/%" Pd "", id);
+  jsobj.AddServiceId("id", f);
 }
 
 
 void Function::PrintJSONImpl(JSONStream* stream, bool ref) const {
   Class& cls = Class::Handle(Owner());
   ASSERT(!cls.IsNull());
   Error& err = Error::Handle();
   err ^= cls.EnsureIsFinalized(Isolate::Current());
   ASSERT(err.IsNull());
   JSONObject jsobj(stream);
   AddTypeProperties(&jsobj, "Function", JSONType(), ref);
-  jsobj.AddProperty("id", GetFunctionServiceId(*this, cls));
+  SetFunctionServiceId(jsobj, *this, cls);
   const String& user_name = String::Handle(PrettyName());
   const String& vm_name = String::Handle(name());
   AddNameProperties(&jsobj, user_name, vm_name);
   const Function& parent = Function::Handle(parent_function());
   if (!parent.IsNull()) {
     jsobj.AddProperty("owner", parent);
   } else if (cls.IsTopLevel()) {
     const Library& library = Library::Handle(cls.library());
     jsobj.AddProperty("owner", library);
   } else {
@@ skipping 1126 matching lines @@
 const char* TokenStream::ToCString() const {
   return "TokenStream";
 }
 
 
 void TokenStream::PrintJSONImpl(JSONStream* stream, bool ref) const {
   JSONObject jsobj(stream);
   AddTypeProperties(&jsobj, "Object", JSONType(), ref);
   // TODO(johnmccutchan): Generate a stable id. TokenStreams hang off
   // a Script object but do not have a back reference to generate a stable id.
-  ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-  const intptr_t id = ring->GetIdForObject(raw());
-  jsobj.AddPropertyF("id", "objects/%" Pd "", id);
+  jsobj.AddServiceId("id", *this);
   if (ref) {
     return;
   }
   Class& cls = Class::Handle(this->clazz());
   jsobj.AddProperty("class", cls);
   jsobj.AddProperty("size", raw()->Size());
   const String& private_key = String::Handle(PrivateKey());
   jsobj.AddProperty("privateKey", private_key);
   // TODO(johnmccutchan): Add support for printing LiteralTokens and add
   // them to members array.
@@ skipping 2646 matching lines @@
                          iter.TryIndex());
   }
   return buffer;
 }
 
 
 void PcDescriptors::PrintToJSONObject(JSONObject* jsobj, bool ref) const {
   AddTypeProperties(jsobj, "Object", JSONType(), ref);
   // TODO(johnmccutchan): Generate a stable id. PcDescriptors hang off a Code
   // object but do not have a back reference to generate an ID.
-  ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-  const intptr_t id = ring->GetIdForObject(raw());
-  jsobj->AddPropertyF("id", "objects/%" Pd "", id);
+  jsobj->AddServiceId("id", *this);
   if (ref) {
     return;
   }
   Class& cls = Class::Handle(this->clazz());
   jsobj->AddProperty("class", cls);
   jsobj->AddProperty("size", raw()->Size());
   JSONArray members(jsobj, "members");
   Iterator iter(*this, RawPcDescriptors::kAnyKind);
   while (iter.MoveNext()) {
     JSONObject descriptor(&members);
@@ skipping 260 matching lines @@
   return buffer;
 }
 
 
 void LocalVarDescriptors::PrintJSONImpl(JSONStream* stream,
                                         bool ref) const {
   JSONObject jsobj(stream);
   AddTypeProperties(&jsobj, "Object", JSONType(), ref);
   // TODO(johnmccutchan): Generate a stable id. LocalVarDescriptors hang off
   // a Code object but do not have a back reference to generate an ID.
-  ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-  const intptr_t id = ring->GetIdForObject(raw());
-  jsobj.AddPropertyF("id", "objects/%" Pd "", id);
+  jsobj.AddServiceId("id", *this);
   if (ref) {
     return;
   }
   Class& cls = Class::Handle(this->clazz());
   jsobj.AddProperty("class", cls);
   jsobj.AddProperty("size", raw()->Size());
   JSONArray members(&jsobj, "members");
   String& var_name = String::Handle();
   for (intptr_t i = 0; i < Length(); i++) {
     RawLocalVarDescriptors::VarInfo info;
@@ skipping 1865 matching lines @@
   IndentN(indent);
   OS::PrintErr("}\n");
 }
 
 
 void Context::PrintJSONImpl(JSONStream* stream, bool ref) const {
   JSONObject jsobj(stream);
   // TODO(turnidge): Should the user level type for Context be Context
   // or Object?
   AddTypeProperties(&jsobj, "Context", JSONType(), ref);
-  ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-  const intptr_t id = ring->GetIdForObject(raw());
-  jsobj.AddPropertyF("id", "objects/%" Pd "", id);
+  jsobj.AddServiceId("id", *this);
 
   jsobj.AddProperty("length", num_variables());
 
   if (ref) {
     return;
   }
 
   Class& cls = Class::Handle(this->clazz());
   jsobj.AddProperty("class", cls);
 
@@ skipping 1181 matching lines @@
     return;
   } else if (raw() == Object::transition_sentinel().raw()) {
     jsobj.AddProperty("type", "Sentinel");
     jsobj.AddProperty("id", "objects/being-initialized");
     jsobj.AddProperty("valueAsString", "<being initialized>");
     return;
   }
 
   AddTypeProperties(&jsobj, "Instance", JSONType(), ref);
   PrintSharedInstanceJSON(&jsobj, ref);
-  ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-  const intptr_t id = ring->GetIdForObject(raw());
+  jsobj.AddServiceId("id", *this);
   if (IsClosure()) {
     const Function& closureFunc = Function::Handle(Closure::function(*this));
     jsobj.AddProperty("closureFunc", closureFunc);
     const Context& closureCtxt = Context::Handle(Closure::context(*this));
     jsobj.AddProperty("closureCtxt", closureCtxt);
   }
-  jsobj.AddPropertyF("id", "objects/%" Pd "", id);
   if (ref) {
     return;
   }
 }
 
 
 bool AbstractType::IsResolved() const {
   // AbstractType is an abstract class.
   UNREACHABLE();
   return false;
@@ skipping 1081 matching lines @@
   AddTypeProperties(&jsobj, "Type", JSONType(), ref);
   PrintSharedInstanceJSON(&jsobj, ref);
   if (IsCanonical()) {
     const Class& type_cls = Class::Handle(type_class());
     intptr_t id = type_cls.FindCanonicalTypeIndex(*this);
     ASSERT(id >= 0);
     intptr_t cid = type_cls.id();
     jsobj.AddPropertyF("id", "classes/%" Pd "/types/%" Pd "", cid, id);
     jsobj.AddProperty("typeClass", type_cls);
   } else {
-    ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-    const intptr_t id = ring->GetIdForObject(raw());
-    jsobj.AddPropertyF("id", "objects/%" Pd "", id);
+    jsobj.AddServiceId("id", *this);
   }
   const String& user_name = String::Handle(PrettyName());
   const String& vm_name = String::Handle(Name());
   AddNameProperties(&jsobj, user_name, vm_name);
   if (ref) {
     return;
   }
   const TypeArguments& typeArgs = TypeArguments::Handle(arguments());
   if (!typeArgs.IsNull()) {
     jsobj.AddProperty("typeArguments", typeArgs);
@@ skipping 162 matching lines @@
     OS::SNPrint(chars, len, format, type_cstr);
     return chars;
   }
 }
 
 
 void TypeRef::PrintJSONImpl(JSONStream* stream, bool ref) const {
   JSONObject jsobj(stream);
   AddTypeProperties(&jsobj, "TypeRef", JSONType(), ref);
   PrintSharedInstanceJSON(&jsobj, ref);
-  ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-  const intptr_t id = ring->GetIdForObject(raw());
-  jsobj.AddPropertyF("id", "objects/%" Pd "", id);
+  jsobj.AddServiceId("id", *this);
   const String& user_name = String::Handle(PrettyName());
   const String& vm_name = String::Handle(Name());
   AddNameProperties(&jsobj, user_name, vm_name);
   if (ref) {
     return;
   }
   jsobj.AddProperty("refType", AbstractType::Handle(type()));
 }
 
 
@@ skipping 213 matching lines @@
   char* chars = Isolate::Current()->current_zone()->Alloc<char>(len);
   OS::SNPrint(chars, len, format, name_cstr, index(), cls_cstr, bound_cstr);
   return chars;
 }
 
 
 void TypeParameter::PrintJSONImpl(JSONStream* stream, bool ref) const {
   JSONObject jsobj(stream);
   AddTypeProperties(&jsobj, "TypeParameter", JSONType(), ref);
   PrintSharedInstanceJSON(&jsobj, ref);
-  ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-  const intptr_t id = ring->GetIdForObject(raw());
-  jsobj.AddPropertyF("id", "objects/%" Pd "", id);
+  jsobj.AddServiceId("id", *this);
   const String& user_name = String::Handle(PrettyName());
   const String& vm_name = String::Handle(Name());
   AddNameProperties(&jsobj, user_name, vm_name);
   const Class& param_cls = Class::Handle(parameterized_class());
   jsobj.AddProperty("parameterizedClass", param_cls);
   if (ref) {
     return;
   }
   jsobj.AddProperty("index", index());
   const AbstractType& upper_bound = AbstractType::Handle(bound());
@@ skipping 195 matching lines @@
   OS::SNPrint(
       chars, len, format, type_cstr, bound_cstr, type_param_cstr, cls_cstr);
   return chars;
 }
 
 
 void BoundedType::PrintJSONImpl(JSONStream* stream, bool ref) const {
   JSONObject jsobj(stream);
   AddTypeProperties(&jsobj, "BoundedType", JSONType(), ref);
   PrintSharedInstanceJSON(&jsobj, ref);
-  ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-  const intptr_t id = ring->GetIdForObject(raw());
-  jsobj.AddPropertyF("id", "objects/%" Pd "", id);
+  jsobj.AddServiceId("id", *this);
   const String& user_name = String::Handle(PrettyName());
   const String& vm_name = String::Handle(Name());
   AddNameProperties(&jsobj, user_name, vm_name);
   if (ref) {
     return;
   }
   jsobj.AddProperty("boundedType", AbstractType::Handle(type()));
   jsobj.AddProperty("upperBound", AbstractType::Handle(bound()));
 }
 
@@ skipping 82 matching lines @@
   // Integer is an interface. No instances of Integer should exist.
   UNREACHABLE();
   return "Integer";
 }
 
 
 void Integer::PrintJSONImpl(JSONStream* stream, bool ref) const {
   JSONObject jsobj(stream);
   AddTypeProperties(&jsobj, "int", JSONType(), ref);
   PrintSharedInstanceJSON(&jsobj, ref);
-  ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-  const intptr_t id = ring->GetIdForObject(raw());
-  jsobj.AddPropertyF("id", "objects/%" Pd "", id);
+  jsobj.AddServiceId("id", *this);
   jsobj.AddProperty("valueAsString", ToCString());
 }
 
 
 // Throw JavascriptIntegerOverflow exception.
 static void ThrowJavascriptIntegerOverflow(const Integer& i) {
   const Array& exc_args = Array::Handle(Array::New(1));
   const String& i_str = String::Handle(String::New(i.ToCString()));
   exc_args.SetAt(0, i_str);
   Exceptions::ThrowByType(Exceptions::kJavascriptIntegerOverflowError,
@@ skipping 672 matching lines @@
   return buffer;
 }
 
 
 void Double::PrintJSONImpl(JSONStream* stream, bool ref) const {
   JSONObject jsobj(stream);
   // Suppress the fact that the internal vm name for this type is
   // "Double".  Return "double" instead.
   AddTypeProperties(&jsobj, "double", "double", ref);
   PrintSharedInstanceJSON(&jsobj, ref);
-  ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-  const intptr_t id = ring->GetIdForObject(raw());
-  jsobj.AddPropertyF("id", "objects/%" Pd "", id);
+  jsobj.AddServiceId("id", *this);
   jsobj.AddProperty("valueAsString", ToCString());
 }
 
 
 bool Bigint::Neg() const {
   return Bool::Handle(neg()).value();
 }
 
 
 void Bigint::SetNeg(bool value) const {
@@ skipping 1570 matching lines @@
     // TODO(turnidge): This is a hack.  The user could have this
     // special string in their program.  Fixing this involves updating
     // the debugging api a bit.
     jsobj.AddProperty("type", "Sentinel");
     jsobj.AddProperty("id", "objects/optimized-out");
     jsobj.AddProperty("valueAsString", "<optimized out>");
     return;
   }
   AddTypeProperties(&jsobj, "String", JSONType(), ref);
   PrintSharedInstanceJSON(&jsobj, ref);
-  ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-  const intptr_t id = ring->GetIdForObject(raw());
-  jsobj.AddPropertyF("id", "objects/%" Pd "", id);
+  jsobj.AddServiceId("id", *this);
   if (ref) {
     bool did_truncate = jsobj.AddPropertyStr("valueAsString", *this, 128);
     if (did_truncate) {
       jsobj.AddProperty("valueAsStringIsTruncated", did_truncate);
     }
   } else {
     bool did_truncate = jsobj.AddPropertyStr("valueAsString", *this);
     ASSERT(!did_truncate);
   }
 }
@@ skipping 1002 matching lines @@
   char* chars = Isolate::Current()->current_zone()->Alloc<char>(len);
   OS::SNPrint(chars, len, format, Length());
   return chars;
 }
 
 
 void Array::PrintJSONImpl(JSONStream* stream, bool ref) const {
   JSONObject jsobj(stream);
   AddTypeProperties(&jsobj, "List", JSONType(), ref);
   PrintSharedInstanceJSON(&jsobj, ref);
-  ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-  const intptr_t id = ring->GetIdForObject(raw());
-  jsobj.AddPropertyF("id", "objects/%" Pd "", id);
+  jsobj.AddServiceId("id", *this);
   jsobj.AddProperty("length", Length());
   if (ref) {
     return;
   }
   {
     JSONArray jsarr(&jsobj, "elements");
     for (intptr_t index = 0; index < Length(); index++) {
       JSONObject jselement(&jsarr);
       jselement.AddProperty("index", index);
 
@@ skipping 230 matching lines @@
   OS::SNPrint(chars, len, format, Length());
   return chars;
 }
 
 
 void GrowableObjectArray::PrintJSONImpl(JSONStream* stream,
                                         bool ref) const {
   JSONObject jsobj(stream);
   AddTypeProperties(&jsobj, "List", JSONType(), ref);
   PrintSharedInstanceJSON(&jsobj, ref);
-  ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-  const intptr_t id = ring->GetIdForObject(raw());
-  jsobj.AddPropertyF("id", "objects/%" Pd "", id);
+  jsobj.AddServiceId("id", *this);
   jsobj.AddProperty("length", Length());
   if (ref) {
     return;
   }
   {
     JSONArray jsarr(&jsobj, "elements");
     for (intptr_t index = 0; index < Length(); index++) {
       JSONObject jselement(&jsarr);
       jselement.AddProperty("index", index);
 
@@ skipping 1027 matching lines @@
 
 const char* WeakProperty::ToCString() const {
   return "_WeakProperty";
 }
 
 
 void WeakProperty::PrintJSONImpl(JSONStream* stream, bool ref) const {
   JSONObject jsobj(stream);
   AddTypeProperties(&jsobj, "Instance", JSONType(), ref);
   PrintSharedInstanceJSON(&jsobj, ref);
-  ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-  const intptr_t id = ring->GetIdForObject(raw());
-  jsobj.AddPropertyF("id", "objects/%" Pd "", id);
-
+  jsobj.AddServiceId("id", *this);
   if (ref) {
     return;
   }
 
   const Object& key_handle = Object::Handle(key());
   jsobj.AddProperty("key", key_handle);
   const Object& value_handle = Object::Handle(value());
   jsobj.AddProperty("value", value_handle);
 }
 
@@ skipping 50 matching lines @@
 
 const char* MirrorReference::ToCString() const {
   return "_MirrorReference";
 }
 
 
 void MirrorReference::PrintJSONImpl(JSONStream* stream, bool ref) const {
   JSONObject jsobj(stream);
   AddTypeProperties(&jsobj, "Instance", JSONType(), ref);
   PrintSharedInstanceJSON(&jsobj, ref);
-  ObjectIdRing* ring = Isolate::Current()->object_id_ring();
-  const intptr_t id = ring->GetIdForObject(raw());
-  jsobj.AddPropertyF("id", "objects/%" Pd "", id);
+  jsobj.AddServiceId("id", *this);
 
   if (ref) {
     return;
   }
 
   const Object& referent_handle = Object::Handle(referent());
   jsobj.AddProperty("referent", referent_handle);
 }
 
 
@@ skipping 124 matching lines @@
   return tag_label.ToCString();
 }
 
 
 void UserTag::PrintJSONImpl(JSONStream* stream, bool ref) const {
   Instance::PrintJSONImpl(stream, ref);
 }
 
 
 }  // namespace dart