Fix a bug in instance canonicalization and add debug mode checks that we are not missing any fields.

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 9184 matching lines @@
       if ((*reinterpret_cast<RawObject**>(this_addr + offset)) !=
           (*reinterpret_cast<RawObject**>(other_addr + offset))) {
         return false;
       }
     }
   }
   return true;
 }
 
 
-RawInstance* Instance::CheckAndCanonicalize(const char** error_str) const {
-  ASSERT(!IsNull());
-  if (this->IsCanonical()) {
-    return this->raw();
+#if defined(DEBUG)
+class CheckForPointers : public ObjectPointerVisitor {
+ public:
+  explicit CheckForPointers(Isolate* isolate)
+      : ObjectPointerVisitor(isolate), has_pointers_(false) {}
+
+  bool has_pointers() const { return has_pointers_; }
+
+  void VisitPointers(RawObject** first, RawObject** last) {
+    if (first != last) {
+      has_pointers_ = true;
+    }
   }
-  Instance& result = Instance::Handle();
+
+ private:
+  bool has_pointers_;
+
+  DISALLOW_COPY_AND_ASSIGN(CheckForPointers);
+};
+#endif  // DEBUG
+
+
+bool Instance::CheckAndCanonicalizeFields(const char** error_str) const {
   const Class& cls = Class::Handle(this->clazz());
-  // TODO(srdjan): Check that predefined classes do not have fields that need
-  // to be checked/canonicalized as well.
-  if ((cls.id() >= kNumPredefinedCids) || cls.IsArray()) {
+  if ((cls.id() >= kNumPredefinedCids)) {
     // Iterate over all fields, canonicalize numbers and strings, expect all
-    // other instances to be canonical otherwise report error (return
-    // Instance::null()).
+    // other instances to be canonical otherwise report error (return false).
     Object& obj = Object::Handle();
-    const intptr_t end_field_offset = cls.instance_size() - kWordSize;
+    intptr_t end_field_offset = cls.instance_size() - kWordSize;
     for (intptr_t field_offset = 0;
          field_offset <= end_field_offset;
          field_offset += kWordSize) {
       obj = *this->FieldAddrAtOffset(field_offset);
       if (obj.IsInstance() && !obj.IsSmi() && !obj.IsCanonical()) {
         if (obj.IsNumber() || obj.IsString()) {
           obj = Instance::Cast(obj).CheckAndCanonicalize(NULL);
           ASSERT(!obj.IsNull());
           this->SetFieldAtOffset(field_offset, obj);
         } else {
           ASSERT(error_str != NULL);
           const char* kFormat = "field: %s\n";
           const intptr_t len =
               OS::SNPrint(NULL, 0, kFormat, obj.ToCString()) + 1;
           char* chars = Isolate::Current()->current_zone()->Alloc<char>(len);
           OS::SNPrint(chars, len, kFormat, obj.ToCString());
           *error_str = chars;
-          return Instance::null();
+          return false;
         }
       }
     }
+  } else {
+#if defined(DEBUG)
+    // Make sure that we are not missing any fields.
+    CheckForPointers has_pointers(Isolate::Current());
+    this->raw()->VisitPointers(&has_pointers);
+    ASSERT(!has_pointers.has_pointers());
+#endif  // DEBUG
+  }
+  return true;
+}
+
+
+RawInstance* Instance::CheckAndCanonicalize(const char** error_str) const {
+  ASSERT(!IsNull());
+  if (this->IsCanonical()) {
+    return this->raw();
+  }
+  Instance& result = Instance::Handle();

[siva, 2013/06/14 22:19:49]

This can be moved below the call to CheckAndCanonicalize

[srdjan, 2013/06/14 22:34:39]

Done.

+  const Class& cls = Class::Handle(this->clazz());

[siva, 2013/06/14 22:19:49]

This line is not needed anymore. Done inside CheckAndCanonicalizeFields

[srdjan, 2013/06/14 22:34:39]

Done.

+  if (!CheckAndCanonicalizeFields(error_str)) {
+    return Instance::null();
   }
   Array& constants = Array::Handle(cls.constants());
   const intptr_t constants_len = constants.Length();
   // Linear search to see whether this value is already present in the
   // list of canonicalized constants.
   intptr_t index = 0;
   while (index < constants_len) {
     result ^= constants.At(index);
     if (result.IsNull()) {
       break;
@@ skipping 3500 matching lines @@
 
   // If there is any left over space fill it with either an Array object or
   // just a plain object (depending on the amount of left over space) so
   // that it can be traversed over successfully during garbage collection.
   Object::MakeUnusedSpaceTraversable(array, capacity_size, used_size);
 
   return array.raw();
 }
 
 
+bool Array::CheckAndCanonicalizeFields(const char** error_str) const {
+  Object& obj = Object::Handle();
+  // Iterate over all elements, canonicalize numbers and strings, expect all
+  // other instances to be canonical otherwise report error (return false).
+  for (intptr_t i = 0; i < Length(); i++) {
+    obj = At(i);
+    if (obj.IsInstance() && !obj.IsSmi() && !obj.IsCanonical()) {
+      if (obj.IsNumber() || obj.IsString()) {
+        obj = Instance::Cast(obj).CheckAndCanonicalize(NULL);
+        ASSERT(!obj.IsNull());
+        this->SetAt(i, obj);
+      } else {
+        ASSERT(error_str != NULL);
+        const char* kFormat = "element at index %"Pd": %s\n";
+        const intptr_t len =
+            OS::SNPrint(NULL, 0, kFormat, i, obj.ToCString()) + 1;
+        char* chars = Isolate::Current()->current_zone()->Alloc<char>(len);
+        OS::SNPrint(chars, len, kFormat, i, obj.ToCString());
+        *error_str = chars;
+        return false;
+      }
+    }
+  }
+  return true;
+}
+
+
 RawImmutableArray* ImmutableArray::New(intptr_t len,
                                        Heap::Space space) {
   ASSERT(Isolate::Current()->object_store()->immutable_array_class() !=
          Class::null());
   return reinterpret_cast<RawImmutableArray*>(Array::New(kClassId, len, space));
 }
 
 
 void GrowableObjectArray::Add(const Object& value, Heap::Space space) const {
   ASSERT(!IsNull());
@@ skipping 768 matching lines @@
                                     space);
   return reinterpret_cast<RawWeakProperty*>(raw);
 }
 
 
 const char* WeakProperty::ToCString() const {
   return "_WeakProperty";
 }
 
 }  // namespace dart