components/metrics: Add runtime memory leak detector

components/metrics/leak_detector/call_stack_table.h

+// Copyright 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.
+
+#ifndef COMPONENTS_METRICS_LEAK_DETECTOR_CALL_STACK_TABLE_H_
+#define COMPONENTS_METRICS_LEAK_DETECTOR_CALL_STACK_TABLE_H_
+
+#include <stdint.h>
+
+#include <functional>
+#include <unordered_map>
+
+#include "components/metrics/leak_detector/leak_analyzer.h"
+#include "components/metrics/leak_detector/stl_allocator.h"
+#include <gperftools/custom_allocator.h>

[wtc, 2015/08/21 20:02:12]

This header file name should probably be put in "" instead of <>.
If the gperftools headers are considered system headers, then
they should be listed with other system headers above.

[Simon Que, 2015/08/22 22:41:51]

Done. The presubmit will fail if they are put in "" so I have instead moved them
up to the system headers.

+
+namespace leak_detector {
+
+// Struct to represent a call stack.
+struct CallStack {
+  static const int kMaxStackDepth = 32;  // Max call stack depth.
+
+  uint32_t depth;                        // Depth of current call stack.
+  const void** stack;                    // Call stack as an array of addrs.
+
+  size_t hash;                           // Hash of call stack.
+};
+
+// Contains a hash table where the key is the call stack and the value is the
+// number of allocations from that call stack.
+class CallStackTable {
+ public:
+  struct Hash {
+    size_t operator() (const CallStack* call_stack) const {
+      // The call stack object should already have a hash computed when it was
+      // created.
+      return call_stack->hash;
+    }
+  };
+
+  explicit CallStackTable(int call_stack_suspicion_threshold);
+  ~CallStackTable();
+
+  // Add/Remove an allocation for the given call stack.
+  void Add(const CallStack* call_stack);
+  void Remove(const CallStack* call_stack);
+
+  // Dump contents to log buffer |buffer| of size |size|. Returns the number of
+  // bytes remaining in the buffer after writing to it. The number of bytes
+  // remaining includes the zero terminator that was just written, so this will
+  // always return at least 1, unless |size| == 0.
+  int Dump(char* buffer, int size) const;
+
+  // Check for leak patterns in the allocation data.
+  void TestForLeaks();
+
+  const LeakAnalyzer& leak_analyzer() const {
+    return leak_analyzer_;
+  }
+
+  bool empty() const {
+    return entry_map_.empty();
+  }
+
+ private:
+  // Hash table entry used to track number of allocs and frees for a call stack.
+  struct Entry {
+    // Number of allocs/frees for the call stack.
+    uint32_t num_allocs;
+    uint32_t num_frees;
+  };
+
+  // The total number of recorded allocations when this object was created. This
+  // acts as a timestamp of sorts.
+  uint64_t total_num_allocs_at_creation_;
+
+  // Total number of allocs and frees in this table.
+  uint32_t num_allocs_;
+  uint32_t num_frees_;
+
+  // Hash table containing entries.
+  using TableEntryAllocator =
+      STL_Allocator<std::pair<const CallStack*, Entry>, CustomAllocator>;
+  std::unordered_map<const CallStack*,
+                     Entry,
+                     Hash,
+                     std::equal_to<const CallStack*>,
+                     TableEntryAllocator> entry_map_;
+
+  // For detecting leak patterns in incoming allocations.
+  LeakAnalyzer leak_analyzer_;
+
+  DISALLOW_COPY_AND_ASSIGN(CallStackTable);
+};
+
+}  // namespace leak_detector
+
+#endif  // CALL_STACK_TABLE_H_

[wtc, 2015/08/21 20:02:12]

Nit: this comment should say
COMPONENTS_METRICS_LEAK_DETECTOR_CALL_STACK_TABLE_H_

[Simon Que, 2015/08/22 22:41:51]

Done.