1
    2
    3
    4
    5
    6
    7
    8
    9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
   73
   74
   75
   76
   77
   78
   79


content / browser / memory / swap_metrics_driver_impl.h [blame]

// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CONTENT_BROWSER_MEMORY_SWAP_METRICS_DRIVER_IMPL_H_
#define CONTENT_BROWSER_MEMORY_SWAP_METRICS_DRIVER_IMPL_H_

#include <memory>

#include "base/gtest_prod_util.h"
#include "base/sequence_checker.h"
#include "base/time/time.h"
#include "base/timer/timer.h"
#include "content/common/content_export.h"
#include "content/public/browser/swap_metrics_driver.h"

namespace content {

// SwapMetricsDriverImpl is the platform independent portion of the
// SwapMetricsDriver implementation.
class CONTENT_EXPORT SwapMetricsDriverImpl : public SwapMetricsDriver {
 public:
  SwapMetricsDriverImpl(const SwapMetricsDriverImpl&) = delete;
  SwapMetricsDriverImpl& operator=(const SwapMetricsDriverImpl&) = delete;

  ~SwapMetricsDriverImpl() override;

  // SwapMetricsDriver
  SwapMetricsDriver::SwapMetricsUpdateResult InitializeMetrics() override;
  bool IsRunning() override;
  SwapMetricsDriver::SwapMetricsUpdateResult Start() override;
  void Stop() override;
  SwapMetricsDriver::SwapMetricsUpdateResult UpdateMetrics() override;

 protected:
  SwapMetricsDriverImpl(std::unique_ptr<Delegate> delegate,
                        const base::TimeDelta update_interval);

  // Periodically called to update swap metrics.
  void PeriodicUpdateMetrics();

  // Common swap metrics update method for both periodic and manual updates.
  SwapMetricsDriver::SwapMetricsUpdateResult UpdateMetricsImpl();

  // Platform-dependent parts of UpdateMetricsImpl(). |interval| is the elapsed
  // time since the last UpdateMetricsImpl() call. |interval| will be zero when
  // this function is called for the first time.
  virtual SwapMetricsDriver::SwapMetricsUpdateResult UpdateMetricsInternal(
      base::TimeDelta interval) = 0;

  // The Delegate observing the metrics updates.
  std::unique_ptr<Delegate> delegate_;

 private:
  FRIEND_TEST_ALL_PREFIXES(TestSwapMetricsDriver, ExpectedMetricCounts);
  FRIEND_TEST_ALL_PREFIXES(TestSwapMetricsDriver, UpdateMetricsFail);

  // The interval between metrics updates.
  base::TimeDelta update_interval_;

  // A periodic timer to update swap metrics.
  base::RepeatingTimer timer_;

  // Holds the last TimeTicks when swap metrics are updated.
  base::TimeTicks last_ticks_;

  // True if and only if InitalizeMetrics() was called, and used to enforce
  // InitializeMetrics() is called before UpdateMetrics(). This helps
  // code readability.
  bool is_initialized_;

  // Updating metrics is not thread safe, and this checks that
  // UpdateMetricsImpl() is always called on the same sequence.
  SEQUENCE_CHECKER(sequence_checker_);
};

}  // namespace content

#endif  // CONTENT_BROWSER_MEMORY_SWAP_METRICS_DRIVER_IMPL_H_