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
|
// 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 "net/dns/system_dns_config_change_notifier.h"
#include <map>
#include <utility>
#include "base/check_op.h"
#include "base/functional/bind.h"
#include "base/location.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/sequence_checker.h"
#include "base/synchronization/lock.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/task_traits.h"
#include "base/task/thread_pool.h"
#include "net/dns/dns_config_service.h"
namespace net {
namespace {
// Internal information and handling for a registered Observer. Handles
// posting to and DCHECKing the correct sequence for the Observer.
class WrappedObserver {
public:
explicit WrappedObserver(SystemDnsConfigChangeNotifier::Observer* observer)
: task_runner_(base::SequencedTaskRunner::GetCurrentDefault()),
observer_(observer) {}
WrappedObserver(const WrappedObserver&) = delete;
WrappedObserver& operator=(const WrappedObserver&) = delete;
~WrappedObserver() { DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_); }
void OnNotifyThreadsafe(absl::optional<DnsConfig> config) {
task_runner_->PostTask(
FROM_HERE,
base::BindOnce(&WrappedObserver::OnNotify,
weak_ptr_factory_.GetWeakPtr(), std::move(config)));
}
void OnNotify(absl::optional<DnsConfig> config) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(!config || config.value().IsValid());
observer_->OnSystemDnsConfigChanged(std::move(config));
}
private:
scoped_refptr<base::SequencedTaskRunner> task_runner_;
const raw_ptr<SystemDnsConfigChangeNotifier::Observer> observer_;
SEQUENCE_CHECKER(sequence_checker_);
base::WeakPtrFactory<WrappedObserver> weak_ptr_factory_{this};
};
} // namespace
// Internal core to be destroyed via base::OnTaskRunnerDeleter to ensure
// sequence safety.
class SystemDnsConfigChangeNotifier::Core {
public:
Core(scoped_refptr<base::SequencedTaskRunner> task_runner,
std::unique_ptr<DnsConfigService> dns_config_service)
: task_runner_(std::move(task_runner)) {
DCHECK(task_runner_);
DCHECK(dns_config_service);
DETACH_FROM_SEQUENCE(sequence_checker_);
task_runner_->PostTask(FROM_HERE,
base::BindOnce(&Core::SetAndStartDnsConfigService,
weak_ptr_factory_.GetWeakPtr(),
std::move(dns_config_service)));
}
Core(const Core&) = delete;
Core& operator=(const Core&) = delete;
~Core() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(wrapped_observers_.empty());
}
void AddObserver(Observer* observer) {
// Create wrapped observer outside locking in case construction requires
// complex side effects.
auto wrapped_observer = std::make_unique<WrappedObserver>(observer);
{
base::AutoLock lock(lock_);
if (config_) {
// Even though this is the same sequence as the observer, use the
// threadsafe OnNotify to post the notification for both lock and
// reentrancy safety.
wrapped_observer->OnNotifyThreadsafe(config_);
}
DCHECK_EQ(0u, wrapped_observers_.count(observer));
wrapped_observers_.emplace(observer, std::move(wrapped_observer));
}
}
void RemoveObserver(Observer* observer) {
// Destroy wrapped observer outside locking in case destruction requires
// complex side effects.
std::unique_ptr<WrappedObserver> removed_wrapped_observer;
{
base::AutoLock lock(lock_);
auto it = wrapped_observers_.find(observer);
DCHECK(it != wrapped_observers_.end());
removed_wrapped_observer = std::move(it->second);
wrapped_observers_.erase(it);
}
}
void RefreshConfig() {
task_runner_->PostTask(FROM_HERE,
base::BindOnce(&Core::TriggerRefreshConfig,
weak_ptr_factory_.GetWeakPtr()));
}
void SetDnsConfigServiceForTesting(
std::unique_ptr<DnsConfigService> dns_config_service,
base::OnceClosure done_cb) {
DCHECK(dns_config_service);
task_runner_->PostTask(FROM_HERE,
base::BindOnce(&Core::SetAndStartDnsConfigService,
weak_ptr_factory_.GetWeakPtr(),
std::move(dns_config_service)));
if (done_cb) {
task_runner_->PostTaskAndReply(
FROM_HERE,
base::BindOnce(&Core::TriggerRefreshConfig,
weak_ptr_factory_.GetWeakPtr()),
std::move(done_cb));
}
}
private:
void SetAndStartDnsConfigService(
std::unique_ptr<DnsConfigService> dns_config_service) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
dns_config_service_ = std::move(dns_config_service);
dns_config_service_->WatchConfig(base::BindRepeating(
&Core::OnConfigChanged, weak_ptr_factory_.GetWeakPtr()));
}
void OnConfigChanged(const DnsConfig& config) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
base::AutoLock lock(lock_);
// |config_| is |absl::nullopt| if most recent config was invalid (or no
// valid config has yet been read), so convert |config| to a similar form
// before comparing for change.
absl::optional<DnsConfig> new_config;
if (config.IsValid())
new_config = config;
if (config_ == new_config)
return;
config_ = std::move(new_config);
for (auto& wrapped_observer : wrapped_observers_) {
wrapped_observer.second->OnNotifyThreadsafe(config_);
}
}
void TriggerRefreshConfig() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
dns_config_service_->RefreshConfig();
}
// Fields that may be accessed from any sequence. Must protect access using
// |lock_|.
mutable base::Lock lock_;
// Only stores valid configs. |absl::nullopt| if most recent config was
// invalid (or no valid config has yet been read).
absl::optional<DnsConfig> config_;
std::map<Observer*, std::unique_ptr<WrappedObserver>> wrapped_observers_;
// Fields valid only on |task_runner_|.
scoped_refptr<base::SequencedTaskRunner> task_runner_;
SEQUENCE_CHECKER(sequence_checker_);
std::unique_ptr<DnsConfigService> dns_config_service_;
base::WeakPtrFactory<Core> weak_ptr_factory_{this};
};
SystemDnsConfigChangeNotifier::SystemDnsConfigChangeNotifier()
: SystemDnsConfigChangeNotifier(
base::ThreadPool::CreateSequencedTaskRunner({base::MayBlock()}),
DnsConfigService::CreateSystemService()) {}
SystemDnsConfigChangeNotifier::SystemDnsConfigChangeNotifier(
scoped_refptr<base::SequencedTaskRunner> task_runner,
std::unique_ptr<DnsConfigService> dns_config_service)
: core_(nullptr, base::OnTaskRunnerDeleter(task_runner)) {
if (dns_config_service)
core_.reset(new Core(task_runner, std::move(dns_config_service)));
}
SystemDnsConfigChangeNotifier::~SystemDnsConfigChangeNotifier() = default;
void SystemDnsConfigChangeNotifier::AddObserver(Observer* observer) {
if (core_)
core_->AddObserver(observer);
}
void SystemDnsConfigChangeNotifier::RemoveObserver(Observer* observer) {
if (core_)
core_->RemoveObserver(observer);
}
void SystemDnsConfigChangeNotifier::RefreshConfig() {
if (core_)
core_->RefreshConfig();
}
void SystemDnsConfigChangeNotifier::SetDnsConfigServiceForTesting(
std::unique_ptr<DnsConfigService> dns_config_service,
base::OnceClosure done_cb) {
DCHECK(core_);
DCHECK(dns_config_service);
core_->SetDnsConfigServiceForTesting( // IN-TEST
std::move(dns_config_service), std::move(done_cb));
}
} // namespace net
|