Process weak reference sets when a scavenge invokes the API callbacks.

runtime/vm/dart_api_impl_test.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 "include/dart_api.h"
 #include "platform/assert.h"
 #include "platform/utils.h"
 #include "vm/class_finalizer.h"
 #include "vm/dart_api_impl.h"
 #include "vm/dart_api_state.h"
@@ skipping 1600 matching lines @@
   EXPECT(!Dart_IsNull(old_pwph));
   Isolate::Current()->heap()->CollectGarbage(Heap::kOld,
                                              Heap::kInvokeApiCallbacks);
   // The prologue weak handle with an old space referent should now be
   // cleared.  The new space referent should remain cleared.
   EXPECT(Dart_IsNull(new_pwph));
   EXPECT(Dart_IsNull(old_pwph));
 }
 
 
-TEST_CASE(ImplicitReferences) {
+TEST_CASE(ImplicitReferencesOldSpace) {
   Dart_Handle strong = Dart_Null();
   EXPECT(Dart_IsNull(strong));
 
   Dart_Handle weak1 = Dart_Null();
   EXPECT(Dart_IsNull(weak1));
 
   Dart_Handle weak2 = Dart_Null();
   EXPECT(Dart_IsNull(weak2));
 
   Dart_Handle weak3 = Dart_Null();
   EXPECT(Dart_IsNull(weak3));
 
-
   Dart_EnterScope();
   {
     Isolate* isolate = Isolate::Current();
     DARTSCOPE(isolate);
 
     strong = Dart_NewPersistentHandle(
         Api::NewHandle(isolate, String::New("strongly reachable", Heap::kOld)));
     EXPECT(!Dart_IsNull(strong));
     EXPECT_VALID(strong);
 
@@ skipping 55 matching lines @@
     Isolate::Current()->heap()->CollectGarbage(Heap::kOld);
   }
 
   // All weak references except weak3 should be preserved.
   EXPECT(!Dart_IsNull(weak1));
   EXPECT(!Dart_IsNull(weak2));
   EXPECT(Dart_IsNull(weak3));
 }
 
 
+TEST_CASE(ImplicitReferencesNewSpace) {
+  Dart_Handle strong = Dart_Null();
+  EXPECT(Dart_IsNull(strong));
+
+  Dart_Handle weak1 = Dart_Null();
+  EXPECT(Dart_IsNull(weak1));
+
+  Dart_Handle weak2 = Dart_Null();
+  EXPECT(Dart_IsNull(weak2));
+
+  Dart_Handle weak3 = Dart_Null();
+  EXPECT(Dart_IsNull(weak3));
+
+  Dart_EnterScope();
+  {
+    Isolate* isolate = Isolate::Current();
+    DARTSCOPE(isolate);
+
+    strong = Dart_NewPersistentHandle(
+        Api::NewHandle(isolate, String::New("strongly reachable", Heap::kNew)));
+    EXPECT(!Dart_IsNull(strong));
+    EXPECT_VALID(strong);
+
+    weak1 = Dart_NewWeakPersistentHandle(
+        Api::NewHandle(isolate, String::New("weakly reachable 1", Heap::kNew)),
+        NULL, NULL);
+    EXPECT(!Dart_IsNull(weak1));
+    EXPECT_VALID(weak1);
+
+    weak2 = Dart_NewWeakPersistentHandle(
+        Api::NewHandle(isolate, String::New("weakly reachable 2", Heap::kNew)),
+        NULL, NULL);
+    EXPECT(!Dart_IsNull(weak2));
+    EXPECT_VALID(weak2);
+
+    weak3 = Dart_NewWeakPersistentHandle(
+        Api::NewHandle(isolate, String::New("weakly reachable 3", Heap::kNew)),
+        NULL, NULL);
+    EXPECT(!Dart_IsNull(weak3));
+    EXPECT_VALID(weak3);
+  }
+  Dart_ExitScope();
+
+  EXPECT_VALID(strong);
+
+  EXPECT_VALID(weak1);
+  EXPECT_VALID(weak2);
+  EXPECT_VALID(weak3);
+
+  Isolate::Current()->heap()->CollectGarbage(Heap::kOld);
+
+  // Old space collection should not affect old space objects.
+  EXPECT(!Dart_IsNull(weak1));
+  EXPECT(!Dart_IsNull(weak2));
+  EXPECT(!Dart_IsNull(weak3));
+
+  // A strongly referenced key should preserve all the values.
+  {
+    Dart_Handle keys[] = { strong };
+    Dart_Handle values[] = { weak1, weak2, weak3 };
+    EXPECT_VALID(Dart_NewWeakReferenceSet(keys, ARRAY_SIZE(keys),
+                                          values, ARRAY_SIZE(values)));
+
+    Isolate::Current()->heap()->CollectGarbage(Heap::kNew,
+                                               Heap::kInvokeApiCallbacks);
+  }
+
+  // All weak references should be preserved.
+  EXPECT(!Dart_IsNull(weak1));
+  EXPECT(!Dart_IsNull(weak2));
+  EXPECT(!Dart_IsNull(weak3));
+
+  Isolate::Current()->heap()->CollectGarbage(Heap::kNew,
+                                             Heap::kIgnoreApiCallbacks);
+
+  // No weak references should be preserved.
+  EXPECT(Dart_IsNull(weak1));
+  EXPECT(Dart_IsNull(weak2));
+  EXPECT(Dart_IsNull(weak3));
+}
+
+
 static int global_prologue_callback_status;
 
 
 static void PrologueCallbackTimes2() {
   global_prologue_callback_status *= 2;
 }
 
 
 static void PrologueCallbackTimes3() {
   global_prologue_callback_status *= 3;
@@ skipping 88 matching lines @@
   // Remove epilogue callbacks again.  This is an error.
   EXPECT(Dart_IsError(Dart_RemoveGcEpilogueCallback(&EpilogueCallbackTimes4)));
   EXPECT(Dart_IsError(Dart_RemoveGcEpilogueCallback(&EpilogueCallbackTimes5)));
 }
 
 
 TEST_CASE(SingleGarbageCollectionCallback) {
   // Add a prologue callback.
   EXPECT_VALID(Dart_AddGcPrologueCallback(&PrologueCallbackTimes2));
 
-  // Garbage collect new space.  This should not invoke the prologue
-  // callback.  No status values should change.
+  // Garbage collect new space ignoring callbacks.  This should not
+  // invoke the prologue callback.  No status values should change.
   global_prologue_callback_status = 3;
   global_epilogue_callback_status = 7;
   Isolate::Current()->heap()->CollectGarbage(Heap::kNew);
   EXPECT_EQ(3, global_prologue_callback_status);
   EXPECT_EQ(7, global_epilogue_callback_status);
 
+  // Garbage collect new space invoking callbacks.  This should
+  // invoke the prologue callback.  No status values should change.
+  global_prologue_callback_status = 3;
+  global_epilogue_callback_status = 7;
+  Isolate::Current()->heap()->CollectGarbage(Heap::kNew,
+                                             Heap::kInvokeApiCallbacks);
+  EXPECT_EQ(6, global_prologue_callback_status);
+  EXPECT_EQ(7, global_epilogue_callback_status);
+
+  // Garbage collect old space ignoring callbacks.  This should invoke
+  // the prologue callback.  The prologue status value should change.
+  global_prologue_callback_status = 3;
+  global_epilogue_callback_status = 7;
+  Isolate::Current()->heap()->CollectGarbage(Heap::kOld,
+                                             Heap::kIgnoreApiCallbacks);
+  EXPECT_EQ(3, global_prologue_callback_status);
+  EXPECT_EQ(7, global_epilogue_callback_status);
+
   // Garbage collect old space.  This should invoke the prologue
   // callback.  The prologue status value should change.
+  global_prologue_callback_status = 3;
+  global_epilogue_callback_status = 7;
   Isolate::Current()->heap()->CollectGarbage(Heap::kOld);
   EXPECT_EQ(6, global_prologue_callback_status);
   EXPECT_EQ(7, global_epilogue_callback_status);
 
   // Garbage collect old space again.  Callbacks are persistent so the
   // prolog status value should change again.
   Isolate::Current()->heap()->CollectGarbage(Heap::kOld);
   EXPECT_EQ(12, global_prologue_callback_status);
   EXPECT_EQ(7, global_epilogue_callback_status);
 
   // Add an epilogue callback.
   EXPECT_VALID(Dart_AddGcEpilogueCallback(&EpilogueCallbackTimes4));
 
   // Garbage collect new space.  This should not invoke the prologue
   // or the epilogue callback.  No status values should change.
   global_prologue_callback_status = 3;
   global_epilogue_callback_status = 7;
   Isolate::Current()->heap()->CollectGarbage(Heap::kNew);
   EXPECT_EQ(3, global_prologue_callback_status);
   EXPECT_EQ(7, global_epilogue_callback_status);
 
+  // Garbage collect new space.  This should invoke the prologue and
+  // the epilogue callback.  The prologue and epilogue status values
+  // should change.
+  Isolate::Current()->heap()->CollectGarbage(Heap::kNew,
+                                             Heap::kInvokeApiCallbacks);
+  EXPECT_EQ(6, global_prologue_callback_status);
+  EXPECT_EQ(28, global_epilogue_callback_status);
+
   // Garbage collect old space.  This should invoke the prologue and
   // the epilogue callbacks.  The prologue and epilogue status values
   // should change.
+  global_prologue_callback_status = 3;
+  global_epilogue_callback_status = 7;
   Isolate::Current()->heap()->CollectGarbage(Heap::kOld);
   EXPECT_EQ(6, global_prologue_callback_status);
   EXPECT_EQ(28, global_epilogue_callback_status);
 
+  // Garbage collect old space again without invoking callbacks.
+  // Nothing should change.
+  Isolate::Current()->heap()->CollectGarbage(Heap::kOld,
+                                             Heap::kIgnoreApiCallbacks);
+  EXPECT_EQ(6, global_prologue_callback_status);
+  EXPECT_EQ(28, global_epilogue_callback_status);
+
   // Garbage collect old space again.  Callbacks are persistent so the
   // prologue and epilogue status values should change again.
   Isolate::Current()->heap()->CollectGarbage(Heap::kOld);
   EXPECT_EQ(12, global_prologue_callback_status);
   EXPECT_EQ(112, global_epilogue_callback_status);
 
   // Remove the prologue and epilogue callbacks
   EXPECT_VALID(Dart_RemoveGcPrologueCallback(&PrologueCallbackTimes2));
   EXPECT_VALID(Dart_RemoveGcEpilogueCallback(&EpilogueCallbackTimes4));
 
@@ skipping 2972 matching lines @@
   EXPECT_VALID(result);
   EXPECT(Dart_IsDouble(result));
   double out;
   result = Dart_DoubleValue(result, &out);
   fprintf(stderr, "Benchmark_UseDartApi: %f us per iteration\n", out);
 }
 
 #endif  // defined(TARGET_ARCH_IA32) || defined(TARGET_ARCH_X64).
 
 }  // namespace dart