Implement a ScopedThreadHeapUsage class to allow profiling per-thread heap usage.

base/debug/scoped_heap_usage.h

+// Copyright 2016 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 BASE_DEBUG_SCOPED_HEAP_USAGE_H_
+#define BASE_DEBUG_SCOPED_HEAP_USAGE_H_
+
+#include <stdint.h>
+
+namespace base {
+namespace debug {
+
+// By keeping a tally on heap operations, it's possible to track:
+// - the number of alloc/free operations (realloc is one of each?)

[chrisha, 2016/07/21 14:23:31]

Makes sense to count one of each, unless the realloc was able to reuse the same
exact address and simply extend it. In which case maybe it counts as neither?

(I'm playing devil's advocate here, no strong opinion either way.)

[Sigurður Ásgeirsson, 2016/08/19 18:21:50]

Dunno - I guess there are degenerate cases either way. In one instance you can
get infinite churn with no operations as memory is freed and allocated in zero
allocations/frees.

+// - the number of bytes allocated/freed.
+// - the number of estimated (lower bound) bytes of heap overhead used.

[chrisha, 2016/07/21 14:23:31]

Will this always be a lower bound, or strictly an estimate? For some platforms
we might not be able to do guarantee any valid lower bound other than '0',
unless we know details of the heap implementation.

[Sigurður Ásgeirsson, 2016/08/19 18:21:49]

Dunno - gotta see how that works out. I've dropped the lower bound comment for
now.

+// - the high-watermark amount of bytes allocated in the scope.
+// This in turn allows measuring the memory usage and memory usage churn over
+// a scope.
+class ScopedHeapUsage {
+ public:
+  struct AllocatorUsage {
+    // The cumulative number of allocation operations.
+    uint64_t alloc_ops;
+    // The cumulative number of allocated bytes.
+    uint64_t alloc_bytes;
+    // The cumulative number of estimated heap overhead bytes.
+    uint64_t alloc_overhead_bytes;
+
+    // The cumulative number of free operations.
+    uint64_t free_ops;
+    // The cumulative number of bytes freed.
+    // Only recorded if the underlying heap shim can return the size of an
+    // allocation.
+    uint64_t free_bytes;
+
+    // The maximal value of alloc_bytes - free_bytes seen for this thread.

[chrisha, 2016/07/21 14:23:31]

Very clear comments, great!

[Sigurður Ásgeirsson, 2016/08/19 18:21:49]

Acknowledged.

+    uint64_t max_allocated_bytes;
+  };
+
+  ScopedHeapUsage();
+  ~ScopedHeapUsage();
+
+  const AllocatorUsage& usage_at_creation() const { return usage_at_creation_; }
+
+  // TODO(siggi): Maybe add a GetUsageSinceCreation() for convenience?
+
+  // Returns this thread's current allocator usage.
+  static AllocatorUsage Now();
+
+  // Initializes the underlying heap shim. Must be called zero or one times.
+  static void Initialize();
+  static void TearDownForTesting();

[chrisha, 2016/07/21 14:23:31]

nit: protect the TearDownForTesting?

A comment about the fact that apparently it is safe to recall Initialize if
TearDown has since been called? Or is this not the case?

[Sigurður Ásgeirsson, 2016/08/19 18:21:49]

Done.
Done.

+
+ private:
+  // The allocator usage for this thread, if any.
+  AllocatorUsage* thread_usage_;
+
+  // The allocator usage captured at creation of this instance.
+  AllocatorUsage usage_at_creation_;
+};
+
+}  // namespace debug
+}  // namespace base
+
+#endif  // BASE_DEBUG_SCOPED_HEAP_USAGE_H_