Updated MallocHooks to collect stack traces when memory is allocated.

runtime/vm/malloc_hooks_test.cc

 // Copyright (c) 2017, 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 "platform/globals.h"
 
 #if defined(DART_USE_TCMALLOC) && !defined(PRODUCT)
 
 #include "platform/assert.h"
-#include "vm/class_finalizer.h"
 #include "vm/globals.h"
 #include "vm/malloc_hooks.h"
-#include "vm/symbols.h"
+#include "vm/profiler.h"
+#include "vm/profiler_service.h"
 #include "vm/unit_test.h"
 
 namespace dart {
 
 static void MallocHookTestBufferInitializer(volatile char* buffer,
                                             uintptr_t size) {
   // Run through the buffer and do something. If we don't do this and the memory
   // in buffer isn't touched, the tcmalloc hooks won't be called.
   for (uintptr_t i = 0; i < size; ++i) {
     buffer[i] = i;
@@ skipping 25 matching lines @@
   MallocHooks::InitOnce();
   const intptr_t pre_hook_buffer_size = 3;
   char* pre_hook_buffer = new char[pre_hook_buffer_size];
   MallocHookTestBufferInitializer(pre_hook_buffer, pre_hook_buffer_size);
 
   MallocHooks::ResetStats();
   EXPECT_EQ(0L, MallocHooks::allocation_count());
   EXPECT_EQ(0L, MallocHooks::heap_allocated_memory_in_bytes());
 
   const intptr_t buffer_size = 10;
-  volatile char* buffer = new char[buffer_size];
+  char* buffer = new char[buffer_size];
   MallocHookTestBufferInitializer(buffer, buffer_size);
 
   EXPECT_EQ(1L, MallocHooks::allocation_count());
   EXPECT_EQ(static_cast<intptr_t>(sizeof(char) * buffer_size),
             MallocHooks::heap_allocated_memory_in_bytes());
 
   delete[] pre_hook_buffer;
   EXPECT_EQ(1L, MallocHooks::allocation_count());
   EXPECT_EQ(static_cast<intptr_t>(sizeof(char) * buffer_size),
             MallocHooks::heap_allocated_memory_in_bytes());
 
 
   delete[] buffer;
   EXPECT_EQ(0L, MallocHooks::allocation_count());
   EXPECT_EQ(0L, MallocHooks::heap_allocated_memory_in_bytes());
   MallocHooks::TearDown();
 }
 
+
+VM_UNIT_TEST_CASE(StackTraceMallocHookSimpleTest) {
+  MallocHooks::ResetStats();
+  ASSERT(MallocHooks::ProfilingEnabled());
+
+  char* var = static_cast<char*>(malloc(16 * sizeof(char)));
+  Sample* sample = MallocHooks::GetSample(var);
+  EXPECT(sample != NULL);
+
+  free(var);
+  sample = MallocHooks::GetSample(var);
+  EXPECT(sample == NULL);
+}
+
+
+#if defined(TARGET_OS_WINDOWS)
+__declspec(noinline) static uintptr_t GetProgramCounter() {

[zra, 2017/02/16 21:45:27]

Use DART_NOINLINE defined in platform/globals.h.

Also this looks copied from vm/profiler.cc. Is there any way to avoid that?
Maybe add this to class OS in vm/os.h.

[bkonyi, 2017/02/16 22:55:06]

Yes, this was from vm/profiler.cc. I've moved the declaration to vm/os.h and
implemented it in os_*.cc.

+  return reinterpret_cast<uintptr_t>(_ReturnAddress());
+}
+#else
+static uintptr_t __attribute__((noinline)) GetProgramCounter() {
+  return reinterpret_cast<uintptr_t>(
+      __builtin_extract_return_addr(__builtin_return_address(0)));
+}
+#endif
+
+
+static char* __attribute__((noinline))

[zra, 2017/02/16 21:45:27]

DART_NOINLINE

[bkonyi, 2017/02/16 22:55:06]

Done.

+StackTraceLengthHelper(uintptr_t* end_address) {
+  char* var = static_cast<char*>(malloc(16 * sizeof(char)));
+  *end_address = GetProgramCounter();
+  return var;
+}
+
+
+VM_UNIT_TEST_CASE(StackTraceMallocHookLengthTest) {
+  uintptr_t test_start_address =
+      reinterpret_cast<uintptr_t>(Dart_TestStackTraceMallocHookLengthTest);
+  uintptr_t helper_start_address =
+      reinterpret_cast<uintptr_t>(StackTraceLengthHelper);
+  uintptr_t helper_end_address = 0;
+
+  MallocHooks::ResetStats();
+  ASSERT(MallocHooks::ProfilingEnabled());
+
+  char* var = StackTraceLengthHelper(&helper_end_address);
+  Sample* sample = MallocHooks::GetSample(var);
+  EXPECT(sample != NULL);
+  uintptr_t test_end_address = GetProgramCounter();
+
+  uword address = sample->At(0);
+  EXPECT((helper_start_address <= address) && (helper_end_address >= address));
+  address = sample->At(1);
+  EXPECT((test_start_address <= address) && (test_end_address >= address));
+  free(var);
+}
+
+
+ISOLATE_UNIT_TEST_CASE(StackTraceMallocHookSimpleJSONTest) {
+  MallocHooks::ResetStats();
+  ASSERT(MallocHooks::ProfilingEnabled());
+  ClearProfileVisitor cpv(Isolate::Current());
+  Profiler::sample_buffer()->VisitSamples(&cpv);
+
+  char* var = static_cast<char*>(malloc(16 * sizeof(char)));
+  JSONStream js;
+  ProfilerService::PrintNativeAllocationJSON(&js, Profile::kNoTags, -1, -1);
+  const char* json = js.ToCString();
+
+  // Check that all the stack frames from the current down to main are actually
+  // present in the profile. This is just a simple sanity check to make sure
+  // that the ProfileTrie has a representation of the stack trace collected when
+  // var is allocated. More intense testing is already done in profiler_test.cc.
+  EXPECT_SUBSTRING("\"dart::Dart_TestStackTraceMallocHookSimpleJSONTest()\"",
+                   json);
+  EXPECT_SUBSTRING("\"dart::TestCase::Run()\"", json);
+  EXPECT_SUBSTRING("\"dart::TestCaseBase::RunTest()\"", json);
+  EXPECT_SUBSTRING("\"main\"", json);
+
+  free(var);
+}
+
 };  // namespace dart
 
 #endif  // defined(DART_USE_TCMALLOC) && !defined(PRODUCT)