components/metrics: Add runtime memory leak detector

third_party/tcmalloc/chromium/src/call_stack_table.cc

+// Copyright (c) 2015 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+// ---
+// Author: Simon Que
+
+#include "call_stack_table.h"
+
+#include <cstring>
+
+#include "base/commandlineflags.h"
+#include "heap-profile-stats.h"
+
+// A call stack must be suspected this many times to be reported as a leak
+// suspect.
+DECLARE_int32(call_stack_suspicion_threshold);
+
+namespace leak_detector {
+
+namespace {
+
+using CallStack = CallStackTable::CallStack;
+
+// Get the top |kRankedListSize| entries.
+const int kRankedListSize = 16;
+
+// Initial number of hash table buckets.
+const int kInitialHashTableSize = 1999;
+
+// Used for printing call stacks in LeakAnalyzer.
+class StringPrint : public LeakAnalyzer<const CallStack*>::StringPrint {
+ public:
+  // Gets the string representation of a value.
+  virtual const char* ValueToString(const CallStack* const& call_stack,
+                                    bool spacing_on) {
+    snprintf(buffer_, sizeof(buffer_), spacing_on ? "%16p" : "%p", call_stack);
+    return buffer_;
+  }
+
+  // Gets the word that describes the value type.
+  virtual const char* ValueTypeName(bool is_plural) {
+    return is_plural ? "call stacks" : "call stack";
+  }
+} string_print;
+
+}  // namespace
+
+CallStackTable::CallStackTable()
+    : num_allocs_(0),
+      num_frees_(0),
+      entry_map_(kInitialHashTableSize),
+      leak_analyzer_(kRankedListSize, FLAGS_call_stack_suspicion_threshold,
+                     &string_print) {
+}
+
+CallStackTable::~CallStackTable() {}
+
+void CallStackTable::Add(const CallStack* call_stack) {
+  auto iter = entry_map_.find(call_stack);
+  Entry* entry = NULL;
+  if (iter == entry_map_.end()) {
+    entry = &entry_map_[call_stack];
+  } else {
+    entry = &iter->second;
+  }
+
+  ++entry->num_allocs;
+  ++num_allocs_;
+}
+
+void CallStackTable::Remove(const CallStack* call_stack) {
+  auto iter = entry_map_.find(call_stack);
+  if (iter == entry_map_.end())
+    return;
+  Entry* entry = &iter->second;
+  ++entry->num_frees;
+  ++num_frees_;
+
+  // If there are no net allocs, delete the entry.
+  if (entry->num_allocs == entry->num_frees)
+    entry_map_.erase(iter);
+}
+
+int CallStackTable::Dump(char* buffer, const int buffer_size) const {
+  int size_left = buffer_size;
+
+  if (entry_map_.empty())
+    return size_left;
+
+  int attempted_size =
+      snprintf(buffer, size_left,
+               "Total number of allocations: %u\n"
+                   "Total number of frees: %u\n"
+                   "Net number of allocations: %u\n"
+                   "Total number of distinct stack traces: %lu\n",
+               num_allocs_, num_frees_, num_allocs_ - num_frees_,
+               entry_map_.size());
+  size_left -= attempted_size;
+  buffer += attempted_size;
+
+  if (size_left > 0) {
+    int attempted_size = leak_analyzer_.Dump(buffer, size_left);
+    size_left -= attempted_size;
+    buffer += attempted_size;
+  }
+
+  if (size_left > 0)
+    return buffer_size - size_left;
+
+  return buffer_size;
+}
+
+void CallStackTable::TestForLeaks() {
+  // Add all entries to the ranked list.
+  RankedList<const CallStack*> ranked_list(kRankedListSize);
+
+  for (const auto& entry_pair : entry_map_) {
+    const Entry& entry = entry_pair.second;
+    if (entry.num_allocs != entry.num_frees)
+      ranked_list.Add(entry_pair.first, entry.num_allocs - entry.num_frees);
+  }
+  leak_analyzer_.AddSample(ranked_list);
+}
+
+}  // namespace leak_detector