Implement a heap profiler for the Dart managed heap.

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 433 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 --
+// --- 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.
@@ skipping 49 matching lines @@
  * \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);
 
+// --- Heap Profiler ---
+
+/**
+ * A callback invoked by the heap profiler during profiling to write
+ * data.
+ */
+typedef void (*Dart_HeapProfileWriteCallback)(const void* data,
+                                              intptr_t length,
+                                              void* stream);
+
+/**
+ * Generates a heap profile.
+ *
+ * \param callback A function pointer that will be repeatedly invoked
+ *   with heap profile data.
+ * \param stream A pointer that will be passed to the callback.  This
+ *   is a convenient way to provide an open stream to the callback.
+ *
+ * \return Success if the heap profile is successful.
+ */
+DART_EXPORT Dart_Handle Dart_HeapProfile(Dart_HeapProfileWriteCallback callback,
+                                         void* stream);
+
 // --- Initialization and Globals ---
 
 /**
  * An isolate creation and initialization callback function.
  *
  * This callback, provided by the embedder, is called when the vm
  * needs to create an isolate. The callback should create an isolate
  * by calling Dart_CreateIsolate and load any scripts required for
  * execution.
  *
@@ skipping 1814 matching lines @@
 // 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);
 
 // Support for generating flow graph compiler debugging output into a file.
 typedef void (*FileWriterFunction)(const char* buffer, int64_t num_bytes);
 DART_EXPORT void Dart_InitFlowGraphPrinting(FileWriterFunction function);
 
 #endif  // INCLUDE_DART_API_H_