Bluetooth: macOS: Adding logs

device/bluetooth/bluetooth_low_energy_device_mac.mm

 // Copyright 2015 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.
 
 #include "device/bluetooth/bluetooth_low_energy_device_mac.h"
 
 #import <CoreFoundation/CoreFoundation.h>
 #include <stddef.h>
 
 #include "base/mac/mac_util.h"
@@ skipping 158 matching lines @@
 
 void BluetoothLowEnergyDeviceMac::ConnectToServiceInsecurely(
     const device::BluetoothUUID& uuid,
     const ConnectToServiceCallback& callback,
     const ConnectToServiceErrorCallback& error_callback) {
   NOTIMPLEMENTED();
 }
 
 void BluetoothLowEnergyDeviceMac::CreateGattConnectionImpl() {
   if (!IsGattConnected()) {
+    VLOG(1) << *this << ": CreateGattConnection.";
     GetMacAdapter()->CreateGattConnection(this);
   }
 }
 
 void BluetoothLowEnergyDeviceMac::DisconnectGatt() {
+  VLOG(1) << *this << ": Disconnect.";
   GetMacAdapter()->DisconnectGatt(this);
 }
 
 void BluetoothLowEnergyDeviceMac::DidDiscoverPrimaryServices(NSError* error) {
   --discovery_pending_count_;
   if (discovery_pending_count_ < 0) {
     // This should never happens, just in case it happens with a device,
     // discovery_pending_count_ is set back to 0.
-    VLOG(1) << GetName()->c_str()
+    VLOG(1) << *this
             << ": BluetoothLowEnergyDeviceMac::discovery_pending_count_ "
             << discovery_pending_count_;
     discovery_pending_count_ = 0;
     return;
   }
   if (error) {
     // TODO(http://crbug.com/609320): Need to pass the error.
     // TODO(http://crbug.com/609844): Decide what to do if discover failed
     // a device services.
-    VLOG(1) << "Can't discover primary services: "
+    VLOG(1) << *this << ": Can't discover primary services: "
             << error.localizedDescription.UTF8String << " (" << error.domain
-            << ": " << error.code << ")";
+            << ": " << error.code << ").";
     return;
   }
-  VLOG(1) << "DidDiscoverPrimaryServices, pending count: "
-          << discovery_pending_count_;
 
   if (!IsGattConnected()) {
     // Don't create services if the device disconnected.
+    VLOG(1) << *this << ": DidDiscoverPrimaryServices, gatt not connected.";
     return;
   }
+  VLOG(1) << *this << ": DidDiscoverPrimaryServices, pending count: "
+          << discovery_pending_count_;
 
   for (CBService* cb_service in GetPeripheral().services) {
     BluetoothRemoteGattServiceMac* gatt_service =
         GetBluetoothRemoteGattService(cb_service);
     if (!gatt_service) {
       gatt_service = new BluetoothRemoteGattServiceMac(this, cb_service,
                                                        true /* is_primary */);
       auto result_iter = gatt_services_.insert(std::make_pair(
           gatt_service->GetIdentifier(), base::WrapUnique(gatt_service)));
       DCHECK(result_iter.second);
+      VLOG(1) << *gatt_service << ": New service.";
       adapter_->NotifyGattServiceAdded(gatt_service);
+    } else {
+      VLOG(1) << *gatt_service << ": Known service.";
     }
   }
   if (discovery_pending_count_ == 0) {
     for (auto it = gatt_services_.begin(); it != gatt_services_.end(); ++it) {
       device::BluetoothRemoteGattService* gatt_service = it->second.get();
       device::BluetoothRemoteGattServiceMac* gatt_service_mac =
           static_cast<BluetoothRemoteGattServiceMac*>(gatt_service);
       gatt_service_mac->DiscoverCharacteristics();
     }
     SendNotificationIfDiscoveryComplete();
   }
 }
 
 void BluetoothLowEnergyDeviceMac::DidDiscoverCharacteristics(
     CBService* cb_service,
     NSError* error) {
   if (error) {
     // TODO(http://crbug.com/609320): Need to pass the error.
     // TODO(http://crbug.com/609844): Decide what to do if discover failed
-    VLOG(1) << "Can't discover characteristics: "
+    VLOG(1) << *this << ": Can't discover characteristics: "
             << error.localizedDescription.UTF8String << " (" << error.domain
-            << ": " << error.code << ")";
+            << ": " << error.code << ").";
     return;
   }
-  VLOG(1) << "DidDiscoverCharacteristics.";
 
   if (!IsGattConnected()) {
+    VLOG(1) << *this << ": DidDiscoverCharacteristics, gatt disconnected.";
     // Don't create characteristics if the device disconnected.
     return;
   }
 
   BluetoothRemoteGattServiceMac* gatt_service =
       GetBluetoothRemoteGattService(cb_service);
   DCHECK(gatt_service);
   gatt_service->DidDiscoverCharacteristics();
   SendNotificationIfDiscoveryComplete();
 }
 
 void BluetoothLowEnergyDeviceMac::DidModifyServices(
     NSArray* invalidatedServices) {
-  VLOG(1) << "DidModifyServices: ";
+  VLOG(1) << *this << ": DidModifyServices: "
+          << " invalidated services "
+          << base::SysNSStringToUTF8([invalidatedServices description]);
   for (CBService* cb_service in invalidatedServices) {
     BluetoothRemoteGattServiceMac* gatt_service =
         GetBluetoothRemoteGattService(cb_service);
     DCHECK(gatt_service);
     VLOG(1) << gatt_service->GetUUID().canonical_value();
     std::unique_ptr<BluetoothRemoteGattService> scoped_service =
         std::move(gatt_services_[gatt_service->GetIdentifier()]);
     gatt_services_.erase(gatt_service->GetIdentifier());
     adapter_->NotifyGattServiceRemoved(scoped_service.get());
   }
   device_uuids_.ClearServiceUUIDs();
   SetGattServicesDiscoveryComplete(false);
   adapter_->NotifyDeviceChanged(this);
   DiscoverPrimaryServices();
 }
 
 void BluetoothLowEnergyDeviceMac::DidUpdateValue(
     CBCharacteristic* characteristic,
     NSError* error) {
-  VLOG(1) << "DidUpdateValue.";
   BluetoothRemoteGattServiceMac* gatt_service =
       GetBluetoothRemoteGattService(characteristic.service);
   DCHECK(gatt_service);
   gatt_service->DidUpdateValue(characteristic, error);
 }
 
 void BluetoothLowEnergyDeviceMac::DidWriteValue(
     CBCharacteristic* characteristic,
     NSError* error) {
-  VLOG(1) << "DidWriteValue.";
   BluetoothRemoteGattServiceMac* gatt_service =
       GetBluetoothRemoteGattService(characteristic.service);
   DCHECK(gatt_service);
   gatt_service->DidWriteValue(characteristic, error);
 }
 
 void BluetoothLowEnergyDeviceMac::DidUpdateNotificationState(
     CBCharacteristic* characteristic,
     NSError* error) {
-  VLOG(1) << "DidUpdateNotificationState";
   BluetoothRemoteGattServiceMac* gatt_service =
       GetBluetoothRemoteGattService(characteristic.service);
   DCHECK(gatt_service);
   gatt_service->DidUpdateNotificationState(characteristic, error);
 }
 
 void BluetoothLowEnergyDeviceMac::DidDiscoverDescriptors(
     CBCharacteristic* cb_characteristic,
     NSError* error) {
   if (error) {
     // TODO(http://crbug.com/609320): Need to pass the error.
     // TODO(http://crbug.com/609844): Decide what to do if discover failed
-    VLOG(1) << "Can't discover descriptors: "
+    VLOG(1) << *this << ": Can't discover descriptors: "
             << error.localizedDescription.UTF8String << " (" << error.domain
-            << ": " << error.code << ")";
+            << ": " << error.code << ").";
     return;
   }
-  VLOG(1) << "DidDiscoverDescriptors.";
   if (!IsGattConnected()) {
+    VLOG(1) << *this << ": DidDiscoverDescriptors, disconnected.";
     // Don't discover descriptors if the device disconnected.
     return;
   }
   BluetoothRemoteGattServiceMac* gatt_service =
       GetBluetoothRemoteGattService(cb_characteristic.service);
   DCHECK(gatt_service);
   gatt_service->DidDiscoverDescriptors(cb_characteristic);
   SendNotificationIfDiscoveryComplete();
 }
 
@@ skipping 11 matching lines @@
     CBPeripheral* peripheral) {
   const size_t kCanonicalAddressNumberOfBytes = 6;
   char raw[kCanonicalAddressNumberOfBytes];
   crypto::SHA256HashString(GetPeripheralIdentifier(peripheral), raw,
                            sizeof(raw));
   std::string hash = base::HexEncode(raw, sizeof(raw));
   return BluetoothDevice::CanonicalizeAddress(hash);
 }
 
 void BluetoothLowEnergyDeviceMac::DiscoverPrimaryServices() {
-  VLOG(1) << "DidDiscoverDescriptors pending count" << discovery_pending_count_;
+  VLOG(1) << *this << ": DiscoverPrimaryServices, pending count "
+          << discovery_pending_count_;
   ++discovery_pending_count_;
   [GetPeripheral() discoverServices:nil];
 }
 
 void BluetoothLowEnergyDeviceMac::SendNotificationIfDiscoveryComplete() {
   // Notify when all services have been discovered.
   bool discovery_complete =
       discovery_pending_count_ == 0 &&
       std::find_if_not(
           gatt_services_.begin(),
           gatt_services_.end(), [](GattServiceMap::value_type & pair) {
             BluetoothRemoteGattService* gatt_service = pair.second.get();
             return static_cast<BluetoothRemoteGattServiceMac*>(gatt_service)
                 ->IsDiscoveryComplete();
           }) == gatt_services_.end();
   if (discovery_complete) {
+    VLOG(1) << *this << ": Discovery complete.";
     device_uuids_.ReplaceServiceUUIDs(gatt_services_);
     SetGattServicesDiscoveryComplete(true);
     adapter_->NotifyGattServicesDiscovered(this);
     adapter_->NotifyDeviceChanged(this);
   }
 }
 
 device::BluetoothAdapterMac* BluetoothLowEnergyDeviceMac::GetMacAdapter() {
   return static_cast<BluetoothAdapterMac*>(this->adapter_);
 }
 
 CBPeripheral* BluetoothLowEnergyDeviceMac::GetPeripheral() {
   return peripheral_;
 }
 
 device::BluetoothRemoteGattServiceMac*
 BluetoothLowEnergyDeviceMac::GetBluetoothRemoteGattService(
     CBService* cb_service) const {
   for (auto it = gatt_services_.begin(); it != gatt_services_.end(); ++it) {
     device::BluetoothRemoteGattService* gatt_service = it->second.get();
     device::BluetoothRemoteGattServiceMac* gatt_service_mac =
         static_cast<BluetoothRemoteGattServiceMac*>(gatt_service);
     if (gatt_service_mac->GetService() == cb_service)
       return gatt_service_mac;
   }
   return nullptr;
 }
 
 void BluetoothLowEnergyDeviceMac::DidDisconnectPeripheral(NSError* error) {
+  VLOG(1) << *this << ": Disconnected from peripheral.";
+  if (error) {
+    VLOG(1) << *this << ": Bluetooth error, domain: " << error.domain.UTF8String
+            << ", error code: " << error.code;
+  }
   SetGattServicesDiscoveryComplete(false);
   // Removing all services at once to ensure that calling GetGattService on
   // removed service in GattServiceRemoved returns null.
   GattServiceMap gatt_services_swapped;
   gatt_services_swapped.swap(gatt_services_);
   gatt_services_swapped.clear();
   device_uuids_.ClearServiceUUIDs();
   // There are two cases in which this function will be called:
   //   1. When the connection to the device breaks (either because
   //      we closed it or the device closed it).
   //   2. When we cancel a pending connection request.
   if (create_gatt_connection_error_callbacks_.empty()) {
     // If there are no pending callbacks then the connection broke (#1).
     DidDisconnectGatt(true /* notifyDeviceChanged */);
     return;
   }
   // Else we canceled the connection request (#2).
   // TODO(http://crbug.com/585897): Need to pass the error.
   DidFailToConnectGatt(BluetoothDevice::ConnectErrorCode::ERROR_FAILED);
 }
+
+namespace device {
+
+std::ostream& operator<<(std::ostream& out,
+                         const BluetoothLowEnergyDeviceMac& device) {
+  // TODO(crbug.com/703878): Should use
+  // BluetoothLowEnergyDeviceMac::GetNameForDisplay() instead.
+  base::Optional<std::string> name = device.GetName();
+  const char* name_cstr = name ? name->c_str() : "";
+  return out << "<BluetoothLowEnergyDeviceMac " << device.GetAddress() << "/"
+             << &device << ", \"" << name_cstr << "\">";
+}
+}  // namespace device