Support "shared" histograms between processes.

components/metrics/metrics_service.h

 // Copyright 2014 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.
 
 // This file defines a service that collects information about the user
 // experience in order to help improve future versions of the app.
 
 #ifndef COMPONENTS_METRICS_METRICS_SERVICE_H_
 #define COMPONENTS_METRICS_METRICS_SERVICE_H_
 
 #include <stdint.h>
 
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/gtest_prod_util.h"
 #include "base/macros.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/scoped_vector.h"
 #include "base/memory/weak_ptr.h"
 #include "base/metrics/field_trial.h"
 #include "base/metrics/histogram_flattener.h"
 #include "base/metrics/histogram_snapshot_manager.h"
+#include "base/metrics/persistent_memory_allocator.h"
 #include "base/metrics/user_metrics.h"
 #include "base/observer_list.h"
 #include "base/time/time.h"
 #include "build/build_config.h"
 #include "components/metrics/clean_exit_beacon.h"
 #include "components/metrics/metrics_log.h"
 #include "components/metrics/metrics_log_manager.h"
 #include "components/metrics/metrics_provider.h"
 #include "components/metrics/net/network_metrics_provider.h"
 #include "components/variations/synthetic_trials.h"
 
 class PrefService;
 class PrefRegistrySimple;
 
 namespace base {
 class DictionaryValue;
 class HistogramSamples;
 class PrefService;
+class SharedMemoryAllocator;
 }
 
 namespace variations {
 struct ActiveGroupId;
 }
 
 namespace net {
 class URLFetcher;
 }
 
@@ skipping 154 matching lines @@
   // should not be called more than once.
   void CheckForClonedInstall(
       scoped_refptr<base::SingleThreadTaskRunner> task_runner);
 
   // Clears the stability metrics that are saved in local state.
   void ClearSavedStabilityMetrics();
 
   // Pushes a log that has been generated by an external component.
   void PushExternalLog(const std::string& log);
 
+  // Add a persistent memory segment that contains histograms. Ownership
+  // of this object remains with the caller; it must be removed from here
+  // before being destroyed.
+  void AddPersistentMemorySegment(base::PersistentMemoryAllocator* alloc);
+
+  // Remove a persistent memory segment. This should be done only after
+  // a final reporting has been done to avoid data loss and incorrect
+  // reporting.
+  void RemovePersistentMemorySegment(base::PersistentMemoryAllocator* alloc);
+
  protected:
   // Exposed for testing.
   MetricsLogManager* log_manager() { return &log_manager_; }
 
  private:
   friend class MetricsServiceAccessor;
 
   // The MetricsService has a lifecycle that is stored as a state.
   // See metrics_service.cc for description of this lifecycle.
   enum State {
@@ skipping 10 matching lines @@
 
   // The current state of recording for the MetricsService. The state is UNSET
   // until set to something else, at which point it remains INACTIVE or ACTIVE
   // for the lifetime of the object.
   enum RecordingState {
     INACTIVE,
     ACTIVE,
     UNSET
   };
 
+  typedef std::set<base::PersistentMemoryAllocator*> AllocatorSet;
   typedef std::vector<variations::SyntheticTrialGroup> SyntheticTrialGroups;
 
   // Registers a field trial name and group to be used to annotate a UMA report
   // with a particular Chrome configuration state. A UMA report will be
   // annotated with this trial group if and only if all events in the report
   // were created after the trial is registered. Only one group name may be
   // registered at a time for a given trial_name. Only the last group name that
   // is registered for a given trial name will be recorded. The values passed
   // in must not correspond to any real field trial in the code.
   void RegisterSyntheticFieldTrial(
       const variations::SyntheticTrialGroup& trial_group);
 
+
+  // A class for iterating over the histograms in persistent memory segments.
+  // This is implemented as an STL-compatible iterator so it can be used in
+  // places that accept histograms both from here and from std containers.
+  class PersistentHistogramIterator {
+    // This class provides a reference-counted pointer to a histogram which
+    // is necessary for histogram objects that are dynamically generated
+    // (generally pointing to persistent memory) and to be owned by an STL
+    // iterator which, by necessity, must be copyable.
+    class HistogramPointer : public base::RefCounted<HistogramPointer> {
+     public:
+      HistogramPointer(base::HistogramBase* h) : histogram_(h) {}
+      base::HistogramBase* get() { return histogram_.get(); }
+
+     private:
+      scoped_ptr<base::HistogramBase> histogram_;
+    };
+
+   public:
+    PersistentHistogramIterator(AllocatorSet& allocators,
+                                AllocatorSet::iterator pos);
+
+    PersistentHistogramIterator& operator++();
+    PersistentHistogramIterator operator++(int) {
+      PersistentHistogramIterator tmp(*this);
+      operator++();
+      return tmp;
+    }
+
+    bool operator==(const PersistentHistogramIterator& rhs) const {
+      return allocator_iter_ == rhs.allocator_iter_ &&
+             histogram_iter_ == rhs.histogram_iter_;
+    }
+    bool operator!=(const PersistentHistogramIterator& rhs) const {
+      return allocator_iter_ != rhs.allocator_iter_ ||
+             histogram_iter_ != rhs.histogram_iter_;
+    }
+    base::HistogramBase* operator*() {
+      return current_histogram_->get();
+    }
+
+   private:
+    AllocatorSet& allocators_;
+    AllocatorSet::iterator allocator_iter_;
+    base::PersistentMemoryAllocator::Iterator histogram_iter_;
+
+    // STL iterators must be copyable so a regular scoped_ptr is not
+    // sufficient as it doesn't allow such. A ref-counted one is needed.
+    scoped_refptr<HistogramPointer> current_histogram_;
+  };
+
+
   // Calls into the client to initialize some system profile metrics.
   void StartInitTask();
 
   // Callback that moves the state to INIT_TASK_DONE. When this is called, the
   // state should be INIT_TASK_SCHEDULED.
   void FinishedInitTask();
 
   void OnUserAction(const std::string& action);
 
   // Get the amount of uptime since this process started and since the last
@@ skipping 118 matching lines @@
   void RecordCurrentHistograms();
 
   // Record complete list of stability histograms into the current log,
   // i.e., histograms with the |kUmaStabilityHistogramFlag| flag set.
   void RecordCurrentStabilityHistograms();
 
   // Skips staged upload and discards the log. Used in case of unsuccessful
   // upload or intentional sampling of logs.
   void SkipAndDiscardUpload();
 
+  // Begin and End iterators for going through all the metrics under management.
+  PersistentHistogramIterator persistent_begin();
+  PersistentHistogramIterator persistent_end();
+
   // Manager for the various in-flight logs.
   MetricsLogManager log_manager_;
 
   // |histogram_snapshot_manager_| prepares histogram deltas for transmission.
   base::HistogramSnapshotManager histogram_snapshot_manager_;
 
   // Used to manage various metrics reporting state prefs, such as client id,
   // low entropy source and whether metrics reporting is enabled. Weak pointer.
   MetricsStateManager* const state_manager_;
 
@@ skipping 62 matching lines @@
   static ExecutionPhase execution_phase_;
 
   // Reduntant marker to check that we completed our shutdown, and set the
   // exited-cleanly bit in the prefs.
   static ShutdownCleanliness clean_shutdown_status_;
 
   FRIEND_TEST_ALL_PREFIXES(MetricsServiceTest, IsPluginProcess);
   FRIEND_TEST_ALL_PREFIXES(MetricsServiceTest,
                            PermutedEntropyCacheClearedWhenLowEntropyReset);
   FRIEND_TEST_ALL_PREFIXES(MetricsServiceTest, RegisterSyntheticTrial);
+  FRIEND_TEST_ALL_PREFIXES(MetricsServiceTest, MultiplePersistentAllocators);
 
   // Weak pointers factory used to post task on different threads. All weak
   // pointers managed by this factory have the same lifetime as MetricsService.
   base::WeakPtrFactory<MetricsService> self_ptr_factory_;
 
   // Weak pointers factory used for saving state. All weak pointers managed by
   // this factory are invalidated in ScheduleNextStateSave.
   base::WeakPtrFactory<MetricsService> state_saver_factory_;
 
+  // Persistent memory segments that contain histograms created elsewhere.
+  AllocatorSet allocators_;
+
   DISALLOW_COPY_AND_ASSIGN(MetricsService);
 };
 
 }  // namespace metrics
 
 #endif  // COMPONENTS_METRICS_METRICS_SERVICE_H_