Support "shared" histograms between processes.

base/metrics/histogram.h

Index: base/metrics/histogram.h
diff --git a/base/metrics/histogram.h b/base/metrics/histogram.h
index 8840493af098437104ed0ba8693e72e860360ab9..7f0a8e350099073980e4f4fc3b3ae4c51464b558 100644
--- a/base/metrics/histogram.h
+++ b/base/metrics/histogram.h
@@ -89,10 +89,13 @@ class BooleanHistogram;
 class CustomHistogram;
 class Histogram;
 class LinearHistogram;
+class PersistentMemoryAllocator;
 class Pickle;
 class PickleIterator;
 class SampleVector;
 
+struct PersistentHistogramData;
+
 class BASE_EXPORT Histogram : public HistogramBase {
  public:
   // Initialize maximum number of buckets in histograms as 16,384.
@@ -190,6 +193,8 @@ class BASE_EXPORT Histogram : public HistogramBase {
   void WriteAscii(std::string* output) const override;
 
  protected:
+  class Factory;
+
   // |ranges| should contain the underflow and overflow buckets. See top
   // comments for example.
   Histogram(const std::string& name,
@@ -197,6 +202,20 @@ class BASE_EXPORT Histogram : public HistogramBase {
             Sample maximum,
             const BucketRanges* ranges);
 
+  // Traditionally, histograms allocate their own memory for the bucket
+  // vector but "shared" histograms use memory regions allocated from a
+  // special memory segment that is passed in here.  It is assumed that
+  // the life of this memory is managed externally and exceeds the lifetime
+  // of this object. Practically, this memory is never released until the
+  // process exits and the OS cleans it up.
+  Histogram(const std::string& name,
+            Sample minimum,
+            Sample maximum,
+            const BucketRanges* ranges,
+            HistogramBase::AtomicCount* counts,
+            size_t counts_size,
+            HistogramSamples::Metadata* meta);
+
   ~Histogram() override;
 
   // HistogramBase implementation:
@@ -225,6 +244,9 @@ class BASE_EXPORT Histogram : public HistogramBase {
   friend class StatisticsRecorder;  // To allow it to delete duplicates.
   friend class StatisticsRecorderTest;
 
+  friend BASE_EXPORT HistogramBase* CreatePersistentHistogram(
+      PersistentMemoryAllocator* allocator,
+      PersistentHistogramData* histogram_data);
   friend BASE_EXPORT HistogramBase* DeserializeHistogramInfo(
       base::PickleIterator* iter);
   static HistogramBase* DeserializeInfoImpl(base::PickleIterator* iter);
@@ -334,11 +356,21 @@ class BASE_EXPORT LinearHistogram : public Histogram {
   HistogramType GetHistogramType() const override;
 
  protected:
+  class Factory;
+
   LinearHistogram(const std::string& name,
                   Sample minimum,
                   Sample maximum,
                   const BucketRanges* ranges);
 
+  LinearHistogram(const std::string& name,
+                  Sample minimum,
+                  Sample maximum,
+                  const BucketRanges* ranges,
+                  HistogramBase::AtomicCount* counts,
+                  size_t counts_size,
+                  HistogramSamples::Metadata* meta);
+
   double GetBucketSize(Count current, size_t i) const override;
 
   // If we have a description for a bucket, then return that.  Otherwise
@@ -350,6 +382,9 @@ class BASE_EXPORT LinearHistogram : public Histogram {
   bool PrintEmptyBucket(size_t index) const override;
 
  private:
+  friend BASE_EXPORT HistogramBase* CreatePersistentHistogram(
+      PersistentMemoryAllocator* allocator,
+      PersistentHistogramData* histogram_data);
   friend BASE_EXPORT HistogramBase* DeserializeHistogramInfo(
       base::PickleIterator* iter);
   static HistogramBase* DeserializeInfoImpl(base::PickleIterator* iter);
@@ -377,9 +412,19 @@ class BASE_EXPORT BooleanHistogram : public LinearHistogram {
 
   HistogramType GetHistogramType() const override;
 
+ protected:
+  class Factory;
+
  private:
   BooleanHistogram(const std::string& name, const BucketRanges* ranges);
-
+  BooleanHistogram(const std::string& name,
+                   const BucketRanges* ranges,
+                   HistogramBase::AtomicCount* counts,
+                   HistogramSamples::Metadata* meta);
+
+  friend BASE_EXPORT HistogramBase* CreatePersistentHistogram(
+      PersistentMemoryAllocator* allocator,
+      PersistentHistogramData* histogram_data);
   friend BASE_EXPORT HistogramBase* DeserializeHistogramInfo(
       base::PickleIterator* iter);
   static HistogramBase* DeserializeInfoImpl(base::PickleIterator* iter);
@@ -419,22 +464,31 @@ class BASE_EXPORT CustomHistogram : public Histogram {
   static std::vector<Sample> ArrayToCustomRanges(const Sample* values,
                                                  size_t num_values);
  protected:
+  class Factory;

[Alexei Svitkine (slow), 2015/12/15 23:03:37]

It's not clear to me why these have to be declared in the header. I don't see
anything in the header using them?

[bcwhite, 2015/12/16 13:36:34]

Everything related to a class has to be declared within the class definition. 
It's not possible to just add new things within the .cc file.  Thus, the
embedded class must at least be declared here even if it's not referenced or
defined here.

[Alexei Svitkine (slow), 2015/12/16 16:33:49]

I guess my point is that it could just be a free-standing class in the anonymous
namespace.

[bcwhite, 2015/12/17 15:55:48]

I tried that originally but such cannot access the non-public constructors of
the various Histogram classes.

+
   CustomHistogram(const std::string& name,
                   const BucketRanges* ranges);
 
+  CustomHistogram(const std::string& name,
+                  const BucketRanges* ranges,
+                  HistogramBase::AtomicCount* counts,
+                  size_t counts_size,
+                  HistogramSamples::Metadata* meta);
+
   // HistogramBase implementation:
   bool SerializeInfoImpl(base::Pickle* pickle) const override;
 
   double GetBucketSize(Count current, size_t i) const override;
 
  private:
+  friend BASE_EXPORT HistogramBase* CreatePersistentHistogram(
+      PersistentMemoryAllocator* allocator,
+      PersistentHistogramData* histogram_data);
   friend BASE_EXPORT HistogramBase* DeserializeHistogramInfo(
       base::PickleIterator* iter);
   static HistogramBase* DeserializeInfoImpl(base::PickleIterator* iter);
 
   static bool ValidateCustomRanges(const std::vector<Sample>& custom_ranges);
-  static BucketRanges* CreateBucketRangesFromCustomRanges(
-      const std::vector<Sample>& custom_ranges);
 
   DISALLOW_COPY_AND_ASSIGN(CustomHistogram);
 };