Implement a garbage collection prologue and epilogue callback mechanism.

runtime/include/dart_api.h

 // 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.
 
 #ifndef INCLUDE_DART_API_H_
 #define INCLUDE_DART_API_H_
 
 /** \mainpage Dart Embedding API Reference
  *
  * Dart is a class-based programming language for creating structured
@@ skipping 254 matching lines @@
  * \param num_values the size of the values set
  *
  * \return Success if the weak reference set could be created.
  *   Otherwise, returns an error handle.
  */
 DART_EXPORT Dart_Handle Dart_NewWeakReferenceSet(Dart_Handle* keys,
                                                  intptr_t num_keys,
                                                  Dart_Handle* values,
                                                  intptr_t num_values);
 
+// --- Garbage Collection Callbacks --
+
+/**
+ * Callbacks signal the beginning and end of a garbage collection.
+ *
+ * These signals are intended to be used by the embedder to manage the
+ * lifetime of native objects with a managed object peer.
+ */
+
+/**
+ * A callback invoked at the beginning of a garbage collection.
+ */
+typedef void (*Dart_GcPrologueCallback)();
+
+/**
+ * A callback invoked at the end of a garbage collection.
+ */
+typedef void (*Dart_GcEpilogueCallback)();
+
+/**
+ * Adds a garbage collection prologue callback.
+ *
+ * \param callback A function pointer to a prologue callback function.
+ *   This function must not have been previously added as a prologue
+ *   callback.
+ *
+ * \return Success if the callback was added.  Otherwise, returns an
+ *   error handle.
+ */
+DART_EXPORT Dart_Handle Dart_AddGcPrologueCallback(
+    Dart_GcPrologueCallback callback);
+
+/**
+ * Removes a garbage collection prologue callback.
+ *
+ * \param callback A function pointer to a prologue callback function.
+ *   This function must have been added as a prologue callback.
+ *
+ * \return Success if the callback was removed.  Otherwise, returns an
+ *   error handle.
+ */
+DART_EXPORT Dart_Handle Dart_RemoveGcPrologueCallback(
+    Dart_GcPrologueCallback callback);
+
+/**
+ * Adds a garbage collection epilogue callback.
+ *
+ * \param callback A function pointer to an epilogue callback
+ *   function.  This function must not have been previously added as
+ *   an epilogue callback.
+ *
+ * \return Success if the callback was added.  Otherwise, returns an
+ *   error handle.
+ */
+DART_EXPORT Dart_Handle Dart_AddGcEpilogueCallback(
+    Dart_GcEpilogueCallback callback);
+
+/**
+ * Removes a garbage collection epilogue callback.
+ *
+ * \param callback A function pointer to an epilogue callback
+ *   function.  This function must have been added as an epilogue
+ *   callback.
+ *
+ * \return Success if the callback was removed.  Otherwise, returns an
+ *   error handle.
+ */
+DART_EXPORT Dart_Handle Dart_RemoveGcEpilogueCallback(
+    Dart_GcEpilogueCallback callback);
 
 // --- Initialization and Globals ---
 
 /**
  * An isolate creation and initialization callback function.
  *
  * This callback, provided by the embedder, is called when an isolate needs
  * to be created. The callback should create an isolate and load the
  * required scripts for execution.
  *
@@ skipping 1565 matching lines @@
 
 // --- Profiling support ----
 
 // External pprof support for gathering and dumping symbolic
 // information that can be used for better profile reports for
 // dynamically generated code.
 DART_EXPORT void Dart_InitPprofSupport();
 DART_EXPORT void Dart_GetPprofSymbolInfo(void** buffer, int* buffer_size);
 
 #endif  // INCLUDE_DART_API_H_