Record Chrome trace events in tcmalloc heap profiles

third_party/tcmalloc/chromium/src/heap-profiler.cc

 // Copyright (c) 2005, Google Inc.
 // All rights reserved.
 // 
 // Redistribution and use in source and binary forms, with or without
 // modification, are permitted provided that the following conditions are
 // met:
 // 
 //     * Redistributions of source code must retain the above copyright
 // notice, this list of conditions and the following disclaimer.
 //     * Redistributions in binary form must reproduce the above
@@ skipping 204 matching lines @@
                                       // (NULL if no need for dumping yet)
 static int   dump_count = 0;          // How many dumps so far
 static int64 last_dump_alloc = 0;     // alloc_size when did we last dump
 static int64 last_dump_free = 0;      // free_size when did we last dump
 static int64 high_water_mark = 0;     // In-use-bytes at last high-water dump
 static int64 last_dump_time = 0;      // The time of the last dump
 
 static HeapProfileTable* heap_profile = NULL;  // the heap profile table
 static DeepHeapProfile* deep_profile = NULL;  // deep memory profiler
 
+// Callback an appplication can use to generate its own "stacks".
+static PseudoStackGenerator pseudo_stack_generator = NULL;
+
 //----------------------------------------------------------------------
 // Profile generation
 //----------------------------------------------------------------------
 
 // Input must be a buffer of size at least 1MB.
 static char* DoGetHeapProfileLocked(char* buf, int buflen) {
   // We used to be smarter about estimating the required memory and
   // then capping it to 1MB and generating the profile into that.
   if (buf == NULL || buflen < 1)
     return NULL;
@@ skipping 140 matching lines @@
   // Take the stack trace outside the critical section.
   void* stack[HeapProfileTable::kMaxStackDepth];
   int depth = HeapProfileTable::GetCallerStackTrace(skip_count + 1, stack);
   SpinLockHolder l(&heap_lock);
   if (is_on) {
     heap_profile->RecordAlloc(ptr, bytes, depth, stack);
     MaybeDumpProfileLocked();
   }
 }
 
+// Record an allocation in the profile. This function is performance critical
+// so it does not attempt to share code with RecordAlloc() above.

[Dai Mikurube (NOT FULLTIME), 2013/07/01 05:47:42]

Is it really performance critical? I don't think it affects performance even if
an if-clause is added while I don't see the actual numbers. Also, in my
understanding, it's not always on (only when tracing is on). I don't think it's
worth to add almost duplicated new functions for it. Do you have numbers that
show performance impact?

The HeapProfiler is almost always on (|is_on|) when (PseudoStack)RecordAlloc is
called.  heap_profile->RecordAlloc is enough heavy to hide the performance
impact since it always computes a hash value from a (maybe pseudo-)stack trace
in GetBucket() and operates a hash table in AddressMap.

In addition, we may be able to do it without an if-clause.

[James Cook, 2013/07/01 23:51:20]

I benchmarked it both with and without a branch (introduced with ?:) -- there is
no measurable difference. Thanks for suggesting I benchmark it.  I consolidated
the functions.

[Dai Mikurube (NOT FULLTIME), 2013/07/02 01:39:06]

Thank you for working on it!

JFYI, I'm not confident, but I think we may not need any branch if you
initialize |pseudo_stack_generator| with HeapProfileTable::GetCallerStackTrace
with using the same function signature.

+static void PseudoStackRecordAlloc(const void* ptr,
+                                   size_t bytes,
+                                   int skip_count) {
+  // Take the stack trace outside the critical section.
+  void* stack[HeapProfileTable::kMaxStackDepth];
+  // Generate our pseudo-stack by via callback into the client code.
+  int depth = (*pseudo_stack_generator)(stack);
+  SpinLockHolder l(&heap_lock);
+  if (is_on) {
+    heap_profile->RecordAlloc(ptr, bytes, depth, stack);
+    MaybeDumpProfileLocked();
+  }
+}
+
 // Record a deallocation in the profile.
 static void RecordFree(const void* ptr) {
   SpinLockHolder l(&heap_lock);
   if (is_on) {
     heap_profile->RecordFree(ptr);
     MaybeDumpProfileLocked();
   }
 }
 
 //----------------------------------------------------------------------
 // Allocation/deallocation hooks for MallocHook
 //----------------------------------------------------------------------
 
 // static
 void NewHook(const void* ptr, size_t size) {
   if (ptr != NULL) RecordAlloc(ptr, size, 0);
 }
 
 // static
 void DeleteHook(const void* ptr) {
   if (ptr != NULL) RecordFree(ptr);
 }
 
+// static
+void PseudoStackNewHook(const void* ptr, size_t size) {
+  if (ptr != NULL) PseudoStackRecordAlloc(ptr, size, 0);
+}
+
 // TODO(jandrews): Re-enable stack tracing
 #ifdef TODO_REENABLE_STACK_TRACING
 static void RawInfoStackDumper(const char* message, void*) {
   RAW_LOG(INFO, "%.*s", static_cast<int>(strlen(message) - 1), message);
   // -1 is to chop the \n which will be added by RAW_LOG
 }
 #endif
 
 static void MmapHook(const void* result, const void* start, size_t size,
                      int prot, int flags, int fd, off_t offset) {
@@ skipping 113 matching lines @@
         DeepHeapProfile(heap_profile, prefix, DeepHeapProfile::PageFrameType(
             FLAGS_deep_heap_profile_pageframe));
   }
 
   // We do not reset dump_count so if the user does a sequence of
   // HeapProfilerStart/HeapProfileStop, we will get a continuous
   // sequence of profiles.
 
   if (FLAGS_only_mmap_profile == false) {
     // Now set the hooks that capture new/delete and malloc/free.
-    RAW_CHECK(MallocHook::AddNewHook(&NewHook), "");
+    if (pseudo_stack_generator) {
+      RAW_CHECK(MallocHook::AddNewHook(&PseudoStackNewHook), "");
+    } else {
+      RAW_CHECK(MallocHook::AddNewHook(&NewHook), "");
+    }
     RAW_CHECK(MallocHook::AddDeleteHook(&DeleteHook), "");
   }
 
-  // Copy filename prefix
-  RAW_DCHECK(filename_prefix == NULL, "");
-  const int prefix_length = strlen(prefix);
-  filename_prefix = reinterpret_cast<char*>(ProfilerMalloc(prefix_length + 1));
-  memcpy(filename_prefix, prefix, prefix_length);
-  filename_prefix[prefix_length] = '\0';
+  // Copy filename prefix if provided.
+  if (prefix) {
+    RAW_DCHECK(filename_prefix == NULL, "");
+    const int prefix_length = strlen(prefix);
+    filename_prefix =
+        reinterpret_cast<char*>(ProfilerMalloc(prefix_length + 1));
+    memcpy(filename_prefix, prefix, prefix_length);
+    filename_prefix[prefix_length] = '\0';
+  }
+}
+
+extern "C" void HeapProfilerWithPseudoStackStart(
+    PseudoStackGenerator callback) {
+  {
+    // Ensure the callback is set before allocations can be recorded.
+    SpinLockHolder l(&heap_lock);
+    pseudo_stack_generator = callback;
+  }
+  HeapProfilerStart(NULL);
+  {
+    // The data from /proc/self/maps is not required for pseudo-stack profiles
+    // and increases the size of the profile dumps significantly.
+    SpinLockHolder l(&heap_lock);
+    heap_profile->DisableProfileSelfMaps();
+  }
 }
 
 extern "C" void IterateAllocatedObjects(AddressVisitor visitor, void* data) {
   SpinLockHolder l(&heap_lock);
 
   if (!is_on) return;
 
   heap_profile->IterateAllocationAddresses(visitor, data);
 }
 
 extern "C" int IsHeapProfilerRunning() {
   SpinLockHolder l(&heap_lock);
   return is_on ? 1 : 0;   // return an int, because C code doesn't have bool
 }
 
 extern "C" void HeapProfilerStop() {
   SpinLockHolder l(&heap_lock);
 
   if (!is_on) return;
 
   if (FLAGS_only_mmap_profile == false) {
     // Unset our new/delete hooks, checking they were set:
-    RAW_CHECK(MallocHook::RemoveNewHook(&NewHook), "");
+    if (pseudo_stack_generator) {
+      RAW_CHECK(MallocHook::RemoveNewHook(&PseudoStackNewHook), "");
+    } else {
+      RAW_CHECK(MallocHook::RemoveNewHook(&NewHook), "");
+    }
     RAW_CHECK(MallocHook::RemoveDeleteHook(&DeleteHook), "");
   }
   if (FLAGS_mmap_log) {
     // Restore mmap/sbrk hooks, checking that our hooks were set:
     RAW_CHECK(MallocHook::RemoveMmapHook(&MmapHook), "");
     RAW_CHECK(MallocHook::RemoveMremapHook(&MremapHook), "");
     RAW_CHECK(MallocHook::RemoveSbrkHook(&SbrkHook), "");
     RAW_CHECK(MallocHook::RemoveMunmapHook(&MunmapHook), "");
   }
 
@@ skipping 85 matching lines @@
 
 // class used for finalization -- dumps the heap-profile at program exit
 struct HeapProfileEndWriter {
   ~HeapProfileEndWriter() { HeapProfilerDump("Exiting"); }
 };
 
 // We want to make sure tcmalloc is up and running before starting the profiler
 static const TCMallocGuard tcmalloc_initializer;
 REGISTER_MODULE_INITIALIZER(heapprofiler, HeapProfilerInit());
 static HeapProfileEndWriter heap_profile_end_writer;