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 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
|
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "device/bluetooth/floss/floss_manager_client.h"
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "base/containers/contains.h"
#include "base/feature_list.h"
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/functional/callback_helpers.h"
#include "base/logging.h"
#include "base/observer_list.h"
#include "base/task/single_thread_task_runner.h"
#include "components/device_event_log/device_event_log.h"
#include "dbus/bus.h"
#include "dbus/exported_object.h"
#include "dbus/message.h"
#include "dbus/object_proxy.h"
#include "device/bluetooth/bluez/bluez_features.h"
#include "device/bluetooth/chromeos_platform_features.h"
#include "device/bluetooth/floss/floss_dbus_client.h"
#include "device/bluetooth/floss/floss_features.h"
namespace floss {
using internal::AdapterWithEnabled;
template <>
bool FlossDBusClient::ReadDBusParam(dbus::MessageReader* reader,
AdapterWithEnabled* adapter) {
static FlossDBusClient::StructReader<AdapterWithEnabled> struct_reader({
{"hci_interface", CreateFieldReader(&AdapterWithEnabled::adapter)},
{"enabled", CreateFieldReader(&AdapterWithEnabled::enabled)},
});
return struct_reader.ReadDBusParam(reader, adapter);
}
template <>
const DBusTypeInfo& GetDBusTypeInfo<AdapterWithEnabled>(
const AdapterWithEnabled* unused) {
static DBusTypeInfo info{"a{sv}", "AdapterWithEnabled"};
return info;
}
// static
const char FlossManagerClient::kExportedCallbacksPath[] =
"/org/chromium/bluetooth/manager/callback";
// static
const char FlossManagerClient::kObjectManagerPath[] = "/";
// static
const int FlossManagerClient::kSetFlossRetryCount = 3;
// static
const int FlossManagerClient::kSetFlossRetryDelayMs = 500;
// static
const int FlossManagerClient::kSetFlossEnabledDBusTimeoutMs = 10000;
FlossManagerClient::FlossManagerClient() = default;
FlossManagerClient::~FlossManagerClient() {
if (object_manager_) {
object_manager_->UnregisterInterface(kManagerInterface);
}
if (bus_) {
bus_->UnregisterExportedObject(dbus::ObjectPath(kExportedCallbacksPath));
}
}
void FlossManagerClient::AddObserver(FlossManagerClient::Observer* observer) {
observers_.AddObserver(observer);
}
void FlossManagerClient::RemoveObserver(
FlossManagerClient::Observer* observer) {
observers_.RemoveObserver(observer);
}
std::vector<int> FlossManagerClient::GetAdapters() const {
std::vector<int> adapters;
for (auto& [adapter, enabled] : adapter_to_enabled_) {
adapters.push_back(adapter);
}
return adapters;
}
int FlossManagerClient::GetDefaultAdapter() const {
return default_adapter_;
}
bool FlossManagerClient::GetAdapterPresent(int adapter) const {
return base::Contains(adapter_to_enabled_, adapter);
}
bool FlossManagerClient::GetAdapterEnabled(int adapter) const {
auto iter = adapter_to_enabled_.find(adapter);
if (iter != adapter_to_enabled_.end()) {
return iter->second;
}
return false;
}
void FlossManagerClient::GetFlossEnabledWithTarget(bool target,
int retry,
int retry_wait_ms) {
CallManagerMethod<bool>(
base::BindOnce(&FlossManagerClient::HandleGetFlossEnabled,
weak_ptr_factory_.GetWeakPtr(), target, retry,
retry_wait_ms),
manager::kGetFlossEnabled);
}
void FlossManagerClient::SetFlossEnabled(
bool enabled,
int retry,
int retry_wait_ms,
std::optional<ResponseCallback<bool>> cb) {
if (cb) {
set_floss_enabled_callback_ =
WeaklyOwnedResponseCallback<bool>::Create(std::move(*cb));
}
CallManagerMethod<Void>(
base::BindOnce(&FlossManagerClient::HandleSetFlossEnabled,
weak_ptr_factory_.GetWeakPtr(), enabled, retry,
retry_wait_ms),
manager::kSetFlossEnabled, enabled);
}
void FlossManagerClient::SetAdapterEnabled(int adapter,
bool enabled,
ResponseCallback<Void> callback) {
if (adapter != GetDefaultAdapter()) {
return;
}
DVLOG(1) << __func__;
adapter_enabled_callback_ =
WeaklyOwnedResponseCallback<Void>::CreateWithTimeout(
std::move(callback), kAdapterEnabledTimeoutMs,
base::unexpected(Error(kErrorNoResponse, "")));
const char* command = enabled ? manager::kStart : manager::kStop;
CallManagerMethod<Void>(
base::BindOnce(&FlossManagerClient::OnSetAdapterEnabled,
weak_ptr_factory_.GetWeakPtr()),
command, adapter);
}
base::Version FlossManagerClient::GetFlossApiVersion() const {
return version_;
}
void FlossManagerClient::DoGetFlossApiVersion() {
CallManagerMethod<uint32_t>(
base::BindOnce(&FlossManagerClient::HandleGetFlossApiVersion,
weak_ptr_factory_.GetWeakPtr()),
manager::kGetFlossApiVersion);
}
bool FlossManagerClient::IsCompatibleFlossApi() {
return version_ >= floss::version::GetMinimalSupportedVersion() &&
version_ <= floss::version::GetMaximalSupportedVersion();
}
void FlossManagerClient::OnSetAdapterEnabled(DBusResult<Void> response) {
// Only handle error cases since non-error called in OnHciEnabledChanged
if (adapter_enabled_callback_ && !response.has_value()) {
adapter_enabled_callback_->Run(
base::unexpected(Error(kErrorNoResponse, "")));
adapter_enabled_callback_.reset();
}
}
void FlossManagerClient::SetLLPrivacy(ResponseCallback<bool> callback,
const bool enable) {
CallExperimentalMethod<bool>(std::move(callback), experimental::kSetLLPrivacy,
enable);
}
// Register manager client against manager.
void FlossManagerClient::RegisterWithManager() {
DCHECK(!manager_available_);
// Get Floss API version of the daemon.
DoGetFlossApiVersion();
// Register for callbacks before Get* calls so we won't miss any state change.
CallManagerMethod<Void>(
base::BindOnce(&FlossManagerClient::HandleRegisterCallback,
weak_ptr_factory_.GetWeakPtr()),
manager::kRegisterCallback, dbus::ObjectPath(kExportedCallbacksPath));
// Get the default adapter.
CallManagerMethod<int>(
base::BindOnce(&FlossManagerClient::HandleGetDefaultAdapter,
weak_ptr_factory_.GetWeakPtr()),
manager::kGetDefaultAdapter);
// Get the list of available adapters.
CallManagerMethod<std::vector<AdapterWithEnabled>>(
base::BindOnce(&FlossManagerClient::HandleGetAvailableAdapters,
weak_ptr_factory_.GetWeakPtr()),
manager::kGetAvailableAdapters);
manager_available_ = true;
for (auto& observer : observers_) {
observer.ManagerPresent(manager_available_);
}
}
// Remove manager client (no longer available).
void FlossManagerClient::RemoveManager() {
// Make copy of old adapters and clear existing ones.
auto previous_adapters = std::move(adapter_to_enabled_);
adapter_to_enabled_.clear();
adapter_present_pending_.clear();
// All old adapters need to be sent a `present = false` notification.
for (auto& [adapter, enabled] : previous_adapters) {
for (auto& observer : observers_) {
observer.AdapterPresent(adapter, false);
}
}
manager_available_ = false;
for (auto& observer : observers_) {
observer.ManagerPresent(manager_available_);
}
}
// The manager can manage multiple adapters so ignore the adapter index given
// here. It is unused.
void FlossManagerClient::Init(dbus::Bus* bus,
const std::string& service_name,
const int adapter_index,
base::Version version,
base::OnceClosure on_ready) {
init_ = false;
bus_ = bus;
service_name_ = service_name;
on_ready_ = std::move(on_ready);
// We should always have object proxy since the client initialization is
// gated on ObjectManager marking the manager interface as available.
if (!bus_->GetObjectProxy(service_name_, dbus::ObjectPath(kManagerObject))) {
LOG(ERROR) << "FlossManagerClient couldn't init. Object proxy was null.";
std::move(on_ready_).Run();
return;
}
DVLOG(1) << __func__;
exported_callback_manager_.Init(bus_.get());
exported_callback_manager_.AddMethod(
manager::kOnHciDeviceChanged,
&FlossManagerClientCallbacks::OnHciDeviceChanged);
exported_callback_manager_.AddMethod(
manager::kOnHciEnabledChanged,
&FlossManagerClientCallbacks::OnHciEnabledChanged);
exported_callback_manager_.AddMethod(
manager::kOnDefaultAdapterChanged,
&FlossManagerClientCallbacks::OnDefaultAdapterChanged);
if (!exported_callback_manager_.ExportCallback(
dbus::ObjectPath(kExportedCallbacksPath),
weak_ptr_factory_.GetWeakPtr(),
base::BindOnce(&FlossManagerClient::RegisterWithManager,
weak_ptr_factory_.GetWeakPtr()))) {
LOG(ERROR) << "Unable to successfully export FlossManagerClientCallbacks.";
std::move(on_ready_).Run();
return;
}
// Register object manager for Manager.
object_manager_ = bus_->GetObjectManager(
service_name, dbus::ObjectPath(kObjectManagerPath));
object_manager_->RegisterInterface(kManagerInterface, this);
#if BUILDFLAG(IS_CHROMEOS)
// Enable Floss and retry a few times until it is set.
SetFlossEnabled(floss::features::IsFlossEnabled(), kSetFlossRetryCount,
kSetFlossRetryDelayMs,
base::BindOnce(&FlossManagerClient::CompleteSetFlossEnabled,
weak_ptr_factory_.GetWeakPtr()));
#endif // BUILDFLAG(IS_CHROMEOS)
}
void FlossManagerClient::HandleGetDefaultAdapter(DBusResult<int32_t> response) {
if (!response.has_value()) {
LOG(ERROR) << "GetDefaultAdapter responded with error: "
<< response.error();
return;
}
OnDefaultAdapterChanged(response.value());
}
void FlossManagerClient::HandleGetAvailableAdapters(
DBusResult<std::vector<AdapterWithEnabled>> adapters) {
if (!adapters.has_value()) {
LOG(WARNING) << "GetAvailableAdapters return error " << adapters.error();
return;
}
auto previous_adapters = std::move(adapter_to_enabled_);
// Clear existing adapters.
adapter_to_enabled_.clear();
adapter_present_pending_.clear();
for (auto v : adapters.value()) {
adapter_to_enabled_.insert({v.adapter, v.enabled});
}
// Trigger the observers for adapter present on any new ones we listed.
for (auto& observer : observers_) {
// Emit present for new adapters that weren't in old list. Also emit the
// enabled changed for them.
for (auto& [adapter, enabled] : adapter_to_enabled_) {
if (!base::Contains(previous_adapters, adapter)) {
observer.AdapterPresent(adapter, true);
observer.AdapterEnabledChanged(adapter, enabled);
}
}
// Emit not present for adapters that aren't in new list.
// We don't need to emit AdapterEnabledChanged since we emit
// AdapterPresent is false
for (auto& [adapter, enabled] : previous_adapters) {
if (!base::Contains(adapter_to_enabled_, adapter)) {
observer.AdapterPresent(adapter, false);
}
}
}
}
void FlossManagerClient::HandleRegisterCallback(DBusResult<Void> result) {
if (!result.has_value()) {
LOG(ERROR) << "Floss manager RegisterCallback returned error: "
<< result.error();
init_ = false;
} else {
init_ = IsCompatibleFlossApi();
}
if (on_ready_) {
std::move(on_ready_).Run();
}
}
void FlossManagerClient::HandleGetAdapterEnabledAfterPresent(
int32_t adapter,
DBusResult<bool> response) {
if (!base::Contains(adapter_present_pending_, adapter)) {
// We may have cleared the pending list in OnHciEnabledChanged.
return;
}
adapter_present_pending_.erase(adapter);
if (!response.has_value()) {
LOG(ERROR) << "Floss manager GetAdapterEnabled returned error: "
<< response.error();
// Default to disabled if the call failed.
adapter_to_enabled_[adapter] = false;
} else {
adapter_to_enabled_[adapter] = response.value();
}
// Don't need to send out AdapterEnabledChanged as BluetoothAdapterFloss
// should query the state proactively.
for (auto& observer : observers_) {
// Always true because this function is only called when present is true.
observer.AdapterPresent(adapter, true);
}
}
void FlossManagerClient::OnHciDeviceChanged(int32_t adapter, bool present) {
auto was_present = base::Contains(adapter_to_enabled_, adapter);
// Newly present
if (!was_present && present) {
if (!base::Contains(adapter_present_pending_, adapter)) {
// Defer the AdapterPresent event until we know the actual state.
adapter_present_pending_.insert(adapter);
CallManagerMethod<bool>(
base::BindOnce(
&FlossManagerClient::HandleGetAdapterEnabledAfterPresent,
weak_ptr_factory_.GetWeakPtr(), adapter),
manager::kGetAdapterEnabled, adapter);
} else {
LOG(WARNING) << "Unexpected OnHciDeviceChanged: adapter " << adapter
<< " already pending";
}
}
// Adapter disappeared
else if (was_present && !present) {
adapter_to_enabled_.erase(adapter);
for (auto& observer : observers_) {
observer.AdapterPresent(adapter, present);
}
}
// Adapter disappeared while pending, only need to clean up pending list
else if (!was_present && !present) {
auto res = adapter_present_pending_.erase(adapter);
if (res == 0) {
LOG(WARNING) << "Unexpected OnHciDeviceChanged: adapter " << adapter
<< " present=" << present << " but not pending";
}
}
// Already present
else if (was_present && present) {
LOG(WARNING) << "Unexpected OnHciDeviceChanged: adapter " << adapter
<< " already present";
}
}
void FlossManagerClient::OnHciEnabledChanged(int32_t adapter, bool enabled) {
adapter_to_enabled_[adapter] = enabled;
if (base::Contains(adapter_present_pending_, adapter)) {
// We haven't notified the presence for this adapter. Notify now.
adapter_present_pending_.erase(adapter);
for (auto& observer : observers_) {
observer.AdapterPresent(adapter, true);
}
}
for (auto& observer : observers_) {
observer.AdapterEnabledChanged(adapter, enabled);
}
if (adapter == GetDefaultAdapter() && adapter_enabled_callback_) {
adapter_enabled_callback_->Run(Void{});
adapter_enabled_callback_.reset();
}
}
void FlossManagerClient::OnDefaultAdapterChanged(int32_t adapter) {
int32_t previous_default = default_adapter_;
default_adapter_ = adapter;
for (auto& observer : observers_) {
observer.DefaultAdapterChanged(previous_default, adapter);
}
}
void FlossManagerClient::HandleSetFlossEnabled(bool target,
int retry,
int retry_wait_ms,
DBusResult<Void> response) {
// Failed to call |SetFlossEnabled| so first log the error and post a delayed
// set if there are retries left.
if (!response.has_value()) {
LOG(ERROR) << response.error();
if (retry > 0) {
base::SingleThreadTaskRunner::GetCurrentDefault()->PostDelayedTask(
FROM_HERE,
base::BindOnce(&FlossManagerClient::SetFlossEnabled,
weak_ptr_factory_.GetWeakPtr(), target, retry - 1,
retry_wait_ms, std::nullopt),
base::Milliseconds(retry_wait_ms));
} else if (set_floss_enabled_callback_) {
set_floss_enabled_callback_->Run(base::unexpected(response.error()));
set_floss_enabled_callback_.reset();
}
return;
}
GetFlossEnabledWithTarget(target, retry, retry_wait_ms);
}
void FlossManagerClient::HandleGetFlossEnabled(bool target,
int retry,
int retry_wait_ms,
DBusResult<bool> response) {
if (!response.has_value()) {
LOG(ERROR) << response.error();
if (retry > 0) {
base::SingleThreadTaskRunner::GetCurrentDefault()->PostDelayedTask(
FROM_HERE,
base::BindOnce(&FlossManagerClient::GetFlossEnabledWithTarget,
weak_ptr_factory_.GetWeakPtr(), target, retry - 1,
retry_wait_ms),
base::Milliseconds(retry_wait_ms));
} else if (set_floss_enabled_callback_) {
set_floss_enabled_callback_->Run(base::unexpected(response.error()));
set_floss_enabled_callback_.reset();
}
return;
}
bool floss_enabled = response.value();
// Target doesn't match reality. Retry |SetFlossEnabled|.
if (floss_enabled != target && retry > 0) {
base::SingleThreadTaskRunner::GetCurrentDefault()->PostDelayedTask(
FROM_HERE,
base::BindOnce(&FlossManagerClient::SetFlossEnabled,
weak_ptr_factory_.GetWeakPtr(), target, retry - 1,
retry_wait_ms, std::nullopt),
base::Milliseconds(kSetFlossRetryDelayMs));
} else {
DVLOG(1) << "Floss is currently "
<< (floss_enabled ? "enabled" : "disabled") << " and target was "
<< (target ? "enabled" : "disabled");
if (set_floss_enabled_callback_) {
set_floss_enabled_callback_->Run(floss_enabled);
set_floss_enabled_callback_.reset();
}
}
}
void FlossManagerClient::CompleteSetFlossEnabled(DBusResult<bool> ret) {
if (!ret.has_value()) {
LOG(ERROR) << "Floss couldn't be enabled. Error=" << ret.error();
} else {
DVLOG(1) << "Completed SetFlossEnabled with value " << *ret;
// Set LL privacy if floss is enabled.
if (floss::features::IsLLPrivacyAvailable() && ret.value()) {
SetLLPrivacy(
base::BindOnce([](DBusResult<bool> ret) {
if (!ret.has_value()) {
LOG(ERROR) << "Set LL privacy returned error: " << ret.error();
} else if (!ret.value()) {
LOG(ERROR) << "Dbus call to set LL privary returned false.\n";
}
}),
base::FeatureList::IsEnabled(bluez::features::kLinkLayerPrivacy));
}
}
}
void FlossManagerClient::HandleGetFlossApiVersion(
DBusResult<uint32_t> response) {
if (!response.has_value()) {
BLUETOOTH_LOG(EVENT) << "Floss API version is not available! Error="
<< response.error();
version_ = base::Version("0.0");
return;
}
uint32_t val = response.value();
version_ = floss::version::IntoVersion(val);
BLUETOOTH_LOG(EVENT) << "Floss API version " << version_;
if (!IsCompatibleFlossApi()) {
BLUETOOTH_LOG(ERROR) << "Unsupported Floss API version " << version_
<< ". Valid range: "
<< floss::version::GetMinimalSupportedVersion()
<< " to "
<< floss::version::GetMaximalSupportedVersion();
}
}
dbus::PropertySet* FlossManagerClient::CreateProperties(
dbus::ObjectProxy* object_proxy,
const dbus::ObjectPath& object_path,
const std::string& interface_name) {
return new dbus::PropertySet(object_proxy, interface_name, base::DoNothing());
}
// Manager interface is available.
void FlossManagerClient::ObjectAdded(const dbus::ObjectPath& object_path,
const std::string& interface_name) {
if (manager_available_) {
return;
}
DVLOG(0) << __func__ << ": " << object_path.value() << ", " << interface_name;
RegisterWithManager();
}
// Manager interface is gone (no longer present).
void FlossManagerClient::ObjectRemoved(const dbus::ObjectPath& object_path,
const std::string& interface_name) {
if (!manager_available_)
return;
DVLOG(0) << __func__ << ": " << object_path.value() << ", " << interface_name;
RemoveManager();
}
// static
std::unique_ptr<FlossManagerClient> FlossManagerClient::Create() {
return std::make_unique<FlossManagerClient>();
}
} // namespace floss
|