[chromeos/about:power] Collect cpuidle and cpufreq stats

chrome/browser/chromeos/power/cpu_data_collector.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.
+
+#ifndef CHROME_BROWSER_CHROMEOS_POWER_CPU_DATA_COLLECTOR_H_
+#define CHROME_BROWSER_CHROMEOS_POWER_CPU_DATA_COLLECTOR_H_
+
+#include <deque>
+#include <map>
+#include <string>
+#include <vector>
+
+#include "base/basictypes.h"
+#include "base/memory/weak_ptr.h"
+#include "base/time/time.h"
+#include "base/timer/timer.h"
+
+namespace chromeos {
+
+// A class to sample CPU idle state occupancy and freq state occupancy.
+// Collects raw data from sysfs and does not convert it to percentage
+// occupancy. As CPUs can be offline at times, or the system can be suspended at
+// other times, it is best for the consumer of this data to calculate percentage
+// occupancy information using suspend time data from
+// PowerDataCollector::system_resumed_data.
+class CpuDataCollector {
+ public:
+  struct StateOccupancySample {
+    StateOccupancySample();
+    ~StateOccupancySample();
+
+    // The time when the data was sampled.
+    base::Time time;
+
+    // Indicates whether the CPU is online.
+    bool cpu_online;
+
+    // A mapping from a CPU state to time spent in that state in milliseconds.
+    // For idle state samples, the name of the state at index i in this vector
+    // is the name at index i in the vector returned by cpu_idle_state_names().
+    // Similarly, for freq state occupancy, similar information is in the vector
+    // returned by cpu_freq_state_names().
+    std::vector<int64> time_in_state;
+  };
+
+  typedef std::deque<StateOccupancySample> StateOccupancySampleDeque;
+
+  const std::vector<std::string>& cpu_idle_state_names() const {
+    return cpu_idle_state_names_;
+  }
+
+  const std::vector<StateOccupancySampleDeque>& cpu_idle_state_data() const {
+    return cpu_idle_state_data_;
+  }
+
+  const std::vector<std::string>& cpu_freq_state_names() const {
+    return cpu_freq_state_names_;
+  }
+
+  const std::vector<StateOccupancySampleDeque>& cpu_freq_state_data() const {
+    return cpu_freq_state_data_;
+  }
+
+  CpuDataCollector();
+  ~CpuDataCollector();
+
+  // Starts a repeating timer which periodically runs a callback to collect
+  // CPU state occupancy samples.
+  void Start();
+
+ private:
+  // Posts callbacks to the blocking pool which collect CPU state occupancy
+  // samples from the sysfs.
+  void PostSampleCpuState();
+
+  // Samples CPU idle and CPU freq data from sysfs. This function should run on
+  // the blocking pool as reading from sysfs is a blocking task. Elements at
+  // index i in |idle_samples| and |freq_samples| correspond to the idle and
+  // freq samples of CPU i.
+  void SampleCpuStateOnBlockingPool(
+      std::vector<std::string>* cpu_idle_state_names,
+      std::vector<StateOccupancySample>* idle_samples,
+      std::vector<std::string>* cpu_freq_state_names,
+      std::vector<StateOccupancySample>* freq_samples);
+
+  // This function commits the samples read by SampleCpuStateOnBlockingPool to
+  // |cpu_idle_state_data_| and |cpu_freq_state_data_|. Since UI is the consumer
+  // of CPU idle and freq data, this function should run on the UI thread.
+  void SaveCpuStateSamplesOnUIThread(
+      const std::vector<std::string>* cpu_idle_state_names,
+      const std::vector<StateOccupancySample>* idle_samples,
+      const std::vector<std::string>* cpu_freq_state_names,
+      const std::vector<StateOccupancySample>* freq_samples);
+
+  base::RepeatingTimer<CpuDataCollector> timer_;
+
+  // Names of the idle states.
+  std::vector<std::string> cpu_idle_state_names_;
+
+  // The deque at index <i> in the vector corresponds to the idle state
+  // occupancy data of CPU<i>.
+  std::vector<StateOccupancySampleDeque> cpu_idle_state_data_;
+
+  // Names of the freq states.
+  std::vector<std::string> cpu_freq_state_names_;
+
+  // The deque at index <i> in the vector corresponds to the frequency state
+  // occupancy data of CPU<i>.
+  std::vector<StateOccupancySampleDeque> cpu_freq_state_data_;
+
+  // The number of CPUs on the system.
+  int cpu_count_;

[Daniel Erat, 2014/03/07 22:28:34]

nit: add a comment documenting that this should only be read or written from the
blocking pool

[Siva Chandra, 2014/03/10 18:46:09]

Done.

+
+  base::WeakPtrFactory<CpuDataCollector> weak_ptr_factory_;
+  DISALLOW_COPY_AND_ASSIGN(CpuDataCollector);
+};
+
+}  // namespace chromeos
+
+#endif  // CHROME_BROWSER_CHROMEOS_POWER_CPU_DATA_COLLECTOR_H_