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 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
|
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/performance_monitor/system_monitor.h"
#include <algorithm>
#include <utility>
#include "base/feature_list.h"
#include "base/memory/ptr_util.h"
#include "base/notreached.h"
#include "base/observer_list.h"
#include "base/task/thread_pool.h"
#include "build/build_config.h"
#if BUILDFLAG(IS_WIN)
#include "chrome/browser/performance_monitor/metric_evaluator_helper_win.h"
#elif BUILDFLAG(IS_POSIX)
#include "chrome/browser/performance_monitor/metric_evaluator_helper_posix.h"
#endif
namespace performance_monitor {
namespace {
using MetricRefreshFrequencies =
SystemMonitor::SystemObserver::MetricRefreshFrequencies;
// The global instance.
SystemMonitor* g_system_metrics_monitor = nullptr;
// The default interval at which the metrics are refreshed.
constexpr base::TimeDelta kDefaultRefreshInterval = base::Seconds(2);
} // namespace
SystemMonitor::SystemMonitor(
std::unique_ptr<MetricEvaluatorsHelper> metric_evaluators_helper)
: blocking_task_runner_(base::ThreadPool::CreateSequencedTaskRunner(
{base::MayBlock(),
base::TaskShutdownBehavior::CONTINUE_ON_SHUTDOWN})),
metric_evaluators_helper_(
metric_evaluators_helper.release(),
base::OnTaskRunnerDeleter(blocking_task_runner_)),
metric_evaluators_metadata_(CreateMetricMetadataArray()) {
DCHECK(!g_system_metrics_monitor);
g_system_metrics_monitor = this;
}
SystemMonitor::~SystemMonitor() {
DCHECK_EQ(this, g_system_metrics_monitor);
g_system_metrics_monitor = nullptr;
}
// static
std::unique_ptr<SystemMonitor> SystemMonitor::Create() {
DCHECK(!g_system_metrics_monitor);
return base::WrapUnique(new SystemMonitor(CreateMetricEvaluatorsHelper()));
}
// static
std::unique_ptr<SystemMonitor> SystemMonitor::CreateForTesting(
std::unique_ptr<MetricEvaluatorsHelper> helper) {
DCHECK(!g_system_metrics_monitor);
return base::WrapUnique(new SystemMonitor(std::move(helper)));
}
// static
SystemMonitor* SystemMonitor::Get() {
return g_system_metrics_monitor;
}
MetricRefreshFrequencies::Builder&
MetricRefreshFrequencies::Builder::SetFreePhysMemoryMbFrequency(
SamplingFrequency freq) {
metrics_and_frequencies_.free_phys_memory_mb_frequency = freq;
return *this;
}
MetricRefreshFrequencies::Builder&
MetricRefreshFrequencies::Builder::SetSystemMetricsSamplingFrequency(
SamplingFrequency freq) {
metrics_and_frequencies_.system_metrics_sampling_frequency = freq;
return *this;
}
MetricRefreshFrequencies MetricRefreshFrequencies::Builder::Build() {
return metrics_and_frequencies_;
}
SystemMonitor::SystemObserver::~SystemObserver() {
if (g_system_metrics_monitor) {
// This is a no-op if the observer has already been removed.
g_system_metrics_monitor->RemoveObserver(this);
}
}
void SystemMonitor::SystemObserver::OnFreePhysicalMemoryMbSample(
int free_phys_memory_mb) {
NOTREACHED();
}
void SystemMonitor::SystemObserver::OnSystemMetricsStruct(
const base::SystemMetrics& system_metrics) {
NOTREACHED();
}
void SystemMonitor::AddOrUpdateObserver(
SystemMonitor::SystemObserver* observer,
MetricRefreshFrequencies metrics_and_frequencies) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (!observers_.HasObserver(observer))
observers_.AddObserver(observer);
observer_metrics_[observer] = std::move(metrics_and_frequencies);
UpdateObservedMetrics();
}
void SystemMonitor::RemoveObserver(SystemMonitor::SystemObserver* observer) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
observers_.RemoveObserver(observer);
if (observer_metrics_.erase(observer))
UpdateObservedMetrics();
}
SystemMonitor::MetricVector SystemMonitor::GetMetricsToEvaluate() const {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
SystemMonitor::MetricVector metrics_to_evaluate;
for (size_t i = 0; i < metrics_refresh_frequencies_.size(); ++i) {
if (metrics_refresh_frequencies_[i] == SamplingFrequency::kNoSampling)
continue;
metrics_to_evaluate.emplace_back(
metric_evaluators_metadata_[i].create_metric_evaluator_function(
metric_evaluators_helper_.get()));
}
return metrics_to_evaluate;
}
// static
SystemMonitor::MetricVector SystemMonitor::EvaluateMetrics(
SystemMonitor::MetricVector metrics_to_evaluate) {
for (auto& metric : metrics_to_evaluate)
metric->Evaluate();
return metrics_to_evaluate;
}
SystemMonitor::MetricMetadataArray SystemMonitor::CreateMetricMetadataArray() {
#define CREATE_METRIC_METADATA(metric_type, value_type, helper_function, \
notify_function, metric_freq_field) \
MetricMetadata( \
[](MetricEvaluatorsHelper* helper) { \
std::unique_ptr<MetricEvaluator> metric = \
base::WrapUnique(new MetricEvaluatorImpl<value_type>( \
MetricEvaluator::Type::metric_type, \
base::BindOnce(&MetricEvaluatorsHelper::helper_function, \
base::Unretained(helper)), \
&SystemObserver::notify_function)); \
return metric; \
}, \
[](const SystemObserver::MetricRefreshFrequencies& \
metric_refresh_frequencies) { \
return metric_refresh_frequencies.metric_freq_field; \
})
return {
CREATE_METRIC_METADATA(kFreeMemoryMb, int, GetFreePhysicalMemoryMb,
OnFreePhysicalMemoryMbSample,
free_phys_memory_mb_frequency),
CREATE_METRIC_METADATA(kSystemMetricsStruct, base::SystemMetrics,
GetSystemMetricsStruct, OnSystemMetricsStruct,
system_metrics_sampling_frequency),
};
#undef CREATE_METRIC_METADATA
} // namespace performance_monitor
void SystemMonitor::UpdateObservedMetrics() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
base::TimeDelta refresh_interval = base::TimeDelta::Max();
// Iterates over the |observer_metrics_| list to find the highest refresh
// frequency for each metric.
for (size_t i = 0; i < metrics_refresh_frequencies_.size(); ++i) {
metrics_refresh_frequencies_[i] = SamplingFrequency::kNoSampling;
for (const auto& obs_iter : observer_metrics_) {
metrics_refresh_frequencies_[i] = std::max(
metrics_refresh_frequencies_[i],
metric_evaluators_metadata_[i].get_refresh_frequency_field_function(
obs_iter.second));
}
if (metrics_refresh_frequencies_[i] != SamplingFrequency::kNoSampling)
refresh_interval = kDefaultRefreshInterval;
}
if (refresh_interval.is_max()) {
refresh_timer_.Stop();
} else if (!refresh_timer_.IsRunning() ||
refresh_interval != refresh_timer_.GetCurrentDelay()) {
refresh_timer_.Start(FROM_HERE, refresh_interval,
base::BindOnce(&SystemMonitor::RefreshCallback,
base::Unretained(this)));
}
}
void SystemMonitor::RefreshCallback() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
blocking_task_runner_->PostTaskAndReplyWithResult(
FROM_HERE,
base::BindOnce(&SystemMonitor::EvaluateMetrics, GetMetricsToEvaluate()),
base::BindOnce(&SystemMonitor::NotifyObservers,
weak_factory_.GetWeakPtr()));
refresh_timer_.Start(
FROM_HERE, refresh_timer_.GetCurrentDelay(),
base::BindOnce(&SystemMonitor::RefreshCallback, base::Unretained(this)));
}
void SystemMonitor::NotifyObservers(SystemMonitor::MetricVector metrics) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
// Iterate over the observers and notify them if a metric has been refreshed
// at the requested frequency.
for (const auto& metric : metrics) {
if (!metric->has_value())
continue;
for (auto& observer : observers_) {
const auto& iter = observer_metrics_.find(&observer);
CHECK(iter != observer_metrics_.end());
if (metric_evaluators_metadata_[static_cast<size_t>(metric->type())]
.get_refresh_frequency_field_function(iter->second) !=
SystemMonitor::SamplingFrequency::kNoSampling) {
metric->NotifyObserver(iter->first);
}
}
}
}
// static
std::unique_ptr<MetricEvaluatorsHelper>
SystemMonitor::CreateMetricEvaluatorsHelper() {
#if BUILDFLAG(IS_WIN)
return base::WrapUnique(new MetricEvaluatorsHelperWin());
#elif BUILDFLAG(IS_POSIX)
return std::make_unique<MetricEvaluatorsHelperPosix>();
#else
#error Unsupported platform
#endif
}
SystemMonitor::MetricEvaluator::MetricEvaluator(Type type) : type_(type) {}
SystemMonitor::MetricEvaluator::~MetricEvaluator() = default;
template <typename T>
SystemMonitor::MetricEvaluatorImpl<T>::MetricEvaluatorImpl(
Type type,
base::OnceCallback<std::optional<T>()> evaluate_function,
void (SystemObserver::*notify_function)(ObserverArgType))
: MetricEvaluator(type),
evaluate_function_(std::move(evaluate_function)),
notify_function_(notify_function) {}
template <typename T>
SystemMonitor::MetricEvaluatorImpl<T>::~MetricEvaluatorImpl() = default;
SystemMonitor::MetricMetadata::MetricMetadata(
std::unique_ptr<MetricEvaluator> (*create_function)(
MetricEvaluatorsHelper* helper),
SamplingFrequency (*get_refresh_field_function)(
const SystemMonitor::SystemObserver::MetricRefreshFrequencies&))
: create_metric_evaluator_function(create_function),
get_refresh_frequency_field_function(get_refresh_field_function) {}
template <typename T>
void SystemMonitor::MetricEvaluatorImpl<T>::NotifyObserver(
SystemObserver* observer) {
DCHECK(value());
(observer->*notify_function_)(value().value());
}
template <typename T>
void SystemMonitor::MetricEvaluatorImpl<T>::Evaluate() {
DCHECK(evaluate_function_);
value_ = std::move(evaluate_function_).Run();
}
std::optional<base::SystemMetrics>
MetricEvaluatorsHelper::GetSystemMetricsStruct() {
return base::SystemMetrics::Sample();
}
} // namespace performance_monitor
|