Heap profiler: count the number of back references for objects.

test/cctest/test-heap-profiler.cc

 // Copyright 2009 the V8 project authors. All rights reserved.
 //
 // Tests for heap profiler
 
 #ifdef ENABLE_LOGGING_AND_PROFILING
 
 #include "v8.h"
 #include "heap-profiler.h"
 #include "string-stream.h"
 #include "cctest.h"
 
 namespace i = v8::internal;
 using i::ClustersCoarser;
 using i::JSObjectsCluster;
+using i::JSObjectsRetainerTree;
 using i::JSObjectsClusterTree;
 using i::RetainerHeapProfile;
 
 
 static void CompileAndRunScript(const char *src) {
   v8::Script::Compile(v8::String::New(src))->Run();
 }
 
 
 namespace {
 
 class ConstructorHeapProfileTestHelper : public i::ConstructorHeapProfile {
  public:
   ConstructorHeapProfileTestHelper()
     : i::ConstructorHeapProfile(),
       f_name_(i::Factory::NewStringFromAscii(i::CStrVector("F"))),
       f_count_(0) {
   }
 
-  void Call(i::String* name, const i::NumberAndSizeInfo& number_and_size) {
-    CHECK(name != NULL);
-    if (f_name_->Equals(name)) {
+  void Call(const JSObjectsCluster& cluster,
+            const i::NumberAndSizeInfo& number_and_size) {
+    if (f_name_->Equals(cluster.constructor())) {
       CHECK_EQ(f_count_, 0);
       f_count_ = number_and_size.number();
       CHECK_GT(f_count_, 0);
     }
   }
 
   int f_count() { return f_count_; }
 
  private:
   i::Handle<i::String> f_name_;
@@ skipping 20 matching lines @@
     i::HeapObject* obj = iterator.next();
     cons_profile.CollectStats(obj);
   }
   CHECK_EQ(0, cons_profile.f_count());
   cons_profile.PrintStats();
   CHECK_EQ(2, cons_profile.f_count());
 }
 
 
 static JSObjectsCluster AddHeapObjectToTree(
-    JSObjectsClusterTree* tree,
+    JSObjectsRetainerTree* tree,
     i::String* constructor,
     int instance,
     JSObjectsCluster* ref1 = NULL,
     JSObjectsCluster* ref2 = NULL,
     JSObjectsCluster* ref3 = NULL) {
   JSObjectsCluster o(constructor, reinterpret_cast<i::Object*>(instance));
   JSObjectsClusterTree* o_tree = new JSObjectsClusterTree();
-  JSObjectsClusterTree::Locator loc;
-  if (ref1 != NULL) o_tree->Insert(*ref1, &loc);
-  if (ref2 != NULL) o_tree->Insert(*ref2, &loc);
-  if (ref3 != NULL) o_tree->Insert(*ref3, &loc);
+  JSObjectsClusterTree::Locator o_loc;
+  if (ref1 != NULL) o_tree->Insert(*ref1, &o_loc);
+  if (ref2 != NULL) o_tree->Insert(*ref2, &o_loc);
+  if (ref3 != NULL) o_tree->Insert(*ref3, &o_loc);
+  JSObjectsRetainerTree::Locator loc;
   tree->Insert(o, &loc);
   loc.set_value(o_tree);
   return o;
 }
 
 
 static inline void CheckEqualsHelper(const char* file, int line,
                                      const char* expected_source,
                                      const JSObjectsCluster& expected,
                                      const char* value_source,
@@ skipping 31 matching lines @@
 }
 
 
 TEST(ClustersCoarserSimple) {
   v8::HandleScope scope;
   v8::Handle<v8::Context> env = v8::Context::New();
   env->Enter();
 
   i::ZoneScope zn_scope(i::DELETE_ON_EXIT);
 
-  JSObjectsClusterTree tree;
+  JSObjectsRetainerTree tree;
   JSObjectsCluster function(i::Heap::function_class_symbol());
   JSObjectsCluster a(*i::Factory::NewStringFromAscii(i::CStrVector("A")));
   JSObjectsCluster b(*i::Factory::NewStringFromAscii(i::CStrVector("B")));
 
   // o1 <- Function
   JSObjectsCluster o1 =
       AddHeapObjectToTree(&tree, i::Heap::Object_symbol(), 0x100, &function);
   // o2 <- Function
   JSObjectsCluster o2 =
       AddHeapObjectToTree(&tree, i::Heap::Object_symbol(), 0x200, &function);
@@ skipping 18 matching lines @@
 }
 
 
 TEST(ClustersCoarserMultipleConstructors) {
   v8::HandleScope scope;
   v8::Handle<v8::Context> env = v8::Context::New();
   env->Enter();
 
   i::ZoneScope zn_scope(i::DELETE_ON_EXIT);
 
-  JSObjectsClusterTree tree;
+  JSObjectsRetainerTree tree;
   JSObjectsCluster function(i::Heap::function_class_symbol());
 
   // o1 <- Function
   JSObjectsCluster o1 =
       AddHeapObjectToTree(&tree, i::Heap::Object_symbol(), 0x100, &function);
   // a1 <- Function
   JSObjectsCluster a1 =
       AddHeapObjectToTree(&tree, i::Heap::Array_symbol(), 0x1000, &function);
   // o2 <- Function
   JSObjectsCluster o2 =
@@ skipping 10 matching lines @@
 }
 
 
 TEST(ClustersCoarserPathsTraversal) {
   v8::HandleScope scope;
   v8::Handle<v8::Context> env = v8::Context::New();
   env->Enter();
 
   i::ZoneScope zn_scope(i::DELETE_ON_EXIT);
 
-  JSObjectsClusterTree tree;
+  JSObjectsRetainerTree tree;
 
   // On the following graph:
   //
   // p
   //   <- o21 <- o11 <-
   // q                  o
   //   <- o22 <- o12 <-
   // r
   //
   // we expect that coarser will deduce equivalences: p ~ q ~ r,
@@ skipping 29 matching lines @@
   CHECK_NE(coarser.GetCoarseEquivalent(o21), coarser.GetCoarseEquivalent(p));
 }
 
 
 namespace {
 
 class RetainerProfilePrinter : public RetainerHeapProfile::Printer {
  public:
   RetainerProfilePrinter() : stream_(&allocator_), lines_(100) {}
 
-  void PrintRetainers(const i::StringStream& retainers) {
+  void PrintRetainers(const JSObjectsCluster& cluster,
+                      const i::StringStream& retainers) {
+    cluster.Print(&stream_);
     stream_.Add("%s", *(retainers.ToCString()));
     stream_.Put('\0');
   }
 
   const char* GetRetainers(const char* constructor) {
     FillLines();
     const size_t cons_len = strlen(constructor);
     for (int i = 0; i < lines_.length(); ++i) {
       if (strncmp(constructor, lines_[i], cons_len) == 0 &&
           lines_[i][cons_len] == ',') {
@@ skipping 26 matching lines @@
 
 
 TEST(RetainerProfile) {
   v8::HandleScope scope;
   v8::Handle<v8::Context> env = v8::Context::New();
   env->Enter();
 
   CompileAndRunScript(
       "function A() {}\n"
       "function B(x) { this.x = x; }\n"
+      "function C(x) { this.x1 = x; this.x2 = x; }\n"
       "var a = new A();\n"
-      "var b = new B(a);\n");
+      "var b1 = new B(a), b2 = new B(a);\n"
+      "var c = new C(a);");
 
   RetainerHeapProfile ret_profile;
   i::AssertNoAllocation no_alloc;
   i::HeapIterator iterator;
   while (iterator.has_next()) {
     i::HeapObject* obj = iterator.next();
     ret_profile.CollectStats(obj);
   }
   RetainerProfilePrinter printer;
   ret_profile.DebugPrintStats(&printer);
-  CHECK_EQ("(global property),B", printer.GetRetainers("A"));
-  CHECK_EQ("(global property)", printer.GetRetainers("B"));
+  CHECK_EQ("(global property);1,B;2,C;2", printer.GetRetainers("A"));
+  CHECK_EQ("(global property);2", printer.GetRetainers("B"));
+  CHECK_EQ("(global property);1", printer.GetRetainers("C"));
 }
 
 #endif  // ENABLE_LOGGING_AND_PROFILING