Reland: Add code to deal with serial device disconnection detection on Windows

device/serial/serial_io_handler_win.cc

 // Copyright 2014 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/serial/serial_io_handler_win.h"
+
 #include <windows.h>
+#include <setupapi.h>
 
-#include "device/serial/serial_io_handler_win.h"
+#include "base/bind.h"
+#include "base/scoped_observer.h"
+#include "base/threading/thread_checker.h"
+#include "device/core/device_info_query_win.h"
+#include "device/core/device_monitor_win.h"
+#include "third_party/re2/re2/re2.h"
 
 namespace device {
 
 namespace {
 
 int BitrateToSpeedConstant(int bitrate) {
 #define BITRATE_TO_SPEED_CASE(x) \
   case x:                        \
     return CBR_##x;
   switch (bitrate) {
@@ skipping 105 matching lines @@
 serial::StopBits StopBitsConstantToEnum(int stop_bits) {
   switch (stop_bits) {
     case TWOSTOPBITS:
       return serial::STOP_BITS_TWO;
     case ONESTOPBIT:
     default:
       return serial::STOP_BITS_ONE;
   }
 }
 
+// Searches for the COM port in the device's friendly name, assigns its value to
+// com_port, and returns whether the operation was successful.
+bool GetCOMPort(const std::string friendly_name, std::string* com_port) {
+  return RE2::PartialMatch(friendly_name, ".* \\((COM[0-9]+)\\)", com_port);
+}
+
 }  // namespace
 
 // static
 scoped_refptr<SerialIoHandler> SerialIoHandler::Create(
     scoped_refptr<base::SingleThreadTaskRunner> file_thread_task_runner,
     scoped_refptr<base::SingleThreadTaskRunner> ui_thread_task_runner) {
   return new SerialIoHandlerWin(file_thread_task_runner, ui_thread_task_runner);
 }
 
+class SerialIoHandlerWin::UiThreadHelper : public DeviceMonitorWin::Observer {
+ public:
+  UiThreadHelper(
+      base::WeakPtr<SerialIoHandlerWin> io_handler,
+      scoped_refptr<base::SingleThreadTaskRunner> io_thread_task_runner)
+      : device_observer_(this),
+        io_handler_(io_handler),
+        io_thread_task_runner_(io_thread_task_runner) {}
+
+  ~UiThreadHelper() { DCHECK(thread_checker_.CalledOnValidThread()); }
+
+  static void Start(UiThreadHelper* self) {
+    self->thread_checker_.DetachFromThread();
+    DeviceMonitorWin* device_monitor = DeviceMonitorWin::GetForAllInterfaces();
+    if (device_monitor)
+      self->device_observer_.Add(device_monitor);
+  }
+
+ private:
+  // DeviceMonitorWin::Observer
+  void OnDeviceRemoved(const GUID& class_guid,
+                       const std::string& device_path) override {
+    DCHECK(thread_checker_.CalledOnValidThread());
+    io_thread_task_runner_->PostTask(
+        FROM_HERE, base::Bind(&SerialIoHandlerWin::OnDeviceRemoved, io_handler_,
+                              device_path));
+  }
+
+  base::ThreadChecker thread_checker_;
+  ScopedObserver<DeviceMonitorWin, DeviceMonitorWin::Observer> device_observer_;
+
+  // This weak pointer is only valid when checked on this task runner.
+  base::WeakPtr<SerialIoHandlerWin> io_handler_;
+  scoped_refptr<base::SingleThreadTaskRunner> io_thread_task_runner_;
+
+  DISALLOW_COPY_AND_ASSIGN(UiThreadHelper);
+};
+
+void SerialIoHandlerWin::OnDeviceRemoved(const std::string& device_path) {
+  DCHECK(CalledOnValidThread());
+
+  device::DeviceInfoQueryWin device_info_query;
+  if (!device_info_query.device_info_list_valid()) {
+    DVPLOG(1) << "Failed to create a device information set";
+    return;
+  }
+
+  // This will add the device so we can query driver info.
+  if (!device_info_query.AddDevice(device_path.c_str())) {
+    DVPLOG(1) << "Failed to get device interface data for " << device_path;
+    return;
+  }
+
+  if (!device_info_query.GetDeviceInfo()) {
+    DVPLOG(1) << "Failed to get device info for " << device_path;
+    return;
+  }
+
+  BYTE friendly_name[512];
+  if (!SetupDiGetDeviceRegistryPropertyA(
+          device_info_query.device_info_list(),
+          device_info_query.device_info_data(), SPDRP_FRIENDLYNAME, NULL,
+          friendly_name, sizeof(friendly_name), NULL)) {
+    DVPLOG(1) << "Failed to get device service property";
+    return;
+  }
+
+  std::string com_port;
+  if (!GetCOMPort(reinterpret_cast<const char*>(friendly_name), &com_port)) {
+    DVPLOG(1) << "Failed to get port name from \"" << friendly_name << "\".";
+    return;
+  }
+
+  if (port() == com_port)
+    CancelRead(serial::RECEIVE_ERROR_DISCONNECTED);
+}
+
 bool SerialIoHandlerWin::PostOpen() {
   DCHECK(!comm_context_);
   DCHECK(!read_context_);
   DCHECK(!write_context_);
 
   base::MessageLoopForIO::current()->RegisterIOHandler(file().GetPlatformFile(),
                                                        this);
 
   comm_context_.reset(new base::MessageLoopForIO::IOContext());
   comm_context_->handler = this;
   memset(&comm_context_->overlapped, 0, sizeof(comm_context_->overlapped));
 
   read_context_.reset(new base::MessageLoopForIO::IOContext());
   read_context_->handler = this;
   memset(&read_context_->overlapped, 0, sizeof(read_context_->overlapped));
 
   write_context_.reset(new base::MessageLoopForIO::IOContext());
   write_context_->handler = this;
   memset(&write_context_->overlapped, 0, sizeof(write_context_->overlapped));
 
+  scoped_refptr<base::SingleThreadTaskRunner> io_thread_task_runner =
+      base::ThreadTaskRunnerHandle::Get();
+  helper_ =
+      new UiThreadHelper(weak_factory_.GetWeakPtr(), io_thread_task_runner);
+  ui_thread_task_runner()->PostTask(
+      FROM_HERE, base::Bind(&UiThreadHelper::Start, helper_));
+
   // A ReadIntervalTimeout of MAXDWORD will cause async reads to complete
   // immediately with any data that's available, even if there is none.
   // This is OK because we never issue a read request until WaitCommEvent
   // signals that data is available.
   COMMTIMEOUTS timeouts = {0};
   timeouts.ReadIntervalTimeout = MAXDWORD;
   if (!::SetCommTimeouts(file().GetPlatformFile(), &timeouts)) {
-    VPLOG(1) << "Failed to set serial timeouts";

[Reilly Grant (use Gerrit), 2015/11/14 01:54:54]

Don't change all of these to debug logs as well. They are useful for debugging
serial API issues in the field.

[juncai, 2015/11/16 21:10:33]

Done.

+    DVPLOG(1) << "Failed to set serial timeouts";
     return false;
   }
 
   return true;
 }
 
 void SerialIoHandlerWin::ReadImpl() {
   DCHECK(CalledOnValidThread());
   DCHECK(pending_read_buffer());
   DCHECK(file().IsValid());
 
   if (!SetCommMask(file().GetPlatformFile(), EV_RXCHAR)) {
-    VPLOG(1) << "Failed to set serial event flags";
+    DVPLOG(1) << "Failed to set serial event flags";
   }
 
   event_mask_ = 0;
   BOOL ok = ::WaitCommEvent(
       file().GetPlatformFile(), &event_mask_, &comm_context_->overlapped);
   if (!ok && GetLastError() != ERROR_IO_PENDING) {
-    VPLOG(1) << "Failed to receive serial event";
+    DVPLOG(1) << "Failed to receive serial event";
     QueueReadCompleted(0, serial::RECEIVE_ERROR_SYSTEM_ERROR);
   }
   is_comm_pending_ = true;
 }
 
 void SerialIoHandlerWin::WriteImpl() {
   DCHECK(CalledOnValidThread());
   DCHECK(pending_write_buffer());
   DCHECK(file().IsValid());
 
   BOOL ok = ::WriteFile(file().GetPlatformFile(),
                         pending_write_buffer(),
                         pending_write_buffer_len(),
                         NULL,
                         &write_context_->overlapped);
   if (!ok && GetLastError() != ERROR_IO_PENDING) {
-    VPLOG(1) << "Write failed";
+    DVPLOG(1) << "Write failed";
     QueueWriteCompleted(0, serial::SEND_ERROR_SYSTEM_ERROR);
   }
 }
 
 void SerialIoHandlerWin::CancelReadImpl() {
   DCHECK(CalledOnValidThread());
   DCHECK(file().IsValid());
   ::CancelIo(file().GetPlatformFile());
 }
 
 void SerialIoHandlerWin::CancelWriteImpl() {
   DCHECK(CalledOnValidThread());
   DCHECK(file().IsValid());
   ::CancelIo(file().GetPlatformFile());
 }
 
 bool SerialIoHandlerWin::ConfigurePortImpl() {
   DCB config = {0};
   config.DCBlength = sizeof(config);
   if (!GetCommState(file().GetPlatformFile(), &config)) {
-    VPLOG(1) << "Failed to get serial port info";
+    DVPLOG(1) << "Failed to get serial port info";
     return false;
   }
 
   // Set up some sane default options that are not configurable.
   config.fBinary = TRUE;
   config.fParity = TRUE;
   config.fAbortOnError = TRUE;
   config.fOutxDsrFlow = FALSE;
   config.fDtrControl = DTR_CONTROL_ENABLE;
   config.fDsrSensitivity = FALSE;
@@ skipping 15 matching lines @@
   DCHECK(options().has_cts_flow_control);
   if (options().cts_flow_control) {
     config.fOutxCtsFlow = TRUE;
     config.fRtsControl = RTS_CONTROL_HANDSHAKE;
   } else {
     config.fOutxCtsFlow = FALSE;
     config.fRtsControl = RTS_CONTROL_ENABLE;
   }
 
   if (!SetCommState(file().GetPlatformFile(), &config)) {
-    VPLOG(1) << "Failed to set serial port info";
+    DVPLOG(1) << "Failed to set serial port info";
     return false;
   }
   return true;
 }
 
 SerialIoHandlerWin::SerialIoHandlerWin(
     scoped_refptr<base::SingleThreadTaskRunner> file_thread_task_runner,
     scoped_refptr<base::SingleThreadTaskRunner> ui_thread_task_runner)
     : SerialIoHandler(file_thread_task_runner, ui_thread_task_runner),
       event_mask_(0),
-      is_comm_pending_(false) {
-}
+      is_comm_pending_(false),
+      weak_factory_(this) {}
 
 SerialIoHandlerWin::~SerialIoHandlerWin() {
+  ui_thread_task_runner()->DeleteSoon(FROM_HERE, helper_);
 }
 
 void SerialIoHandlerWin::OnIOCompleted(
     base::MessageLoopForIO::IOContext* context,
     DWORD bytes_transferred,
     DWORD error) {
   DCHECK(CalledOnValidThread());
   if (context == comm_context_) {
     DWORD errors;
     COMSTAT status;
@@ skipping 19 matching lines @@
       ReadCompleted(bytes_transferred, read_cancel_reason());
     } else if (error != ERROR_SUCCESS && error != ERROR_OPERATION_ABORTED) {
       ReadCompleted(0, serial::RECEIVE_ERROR_SYSTEM_ERROR);
     } else if (pending_read_buffer()) {
       BOOL ok = ::ReadFile(file().GetPlatformFile(),
                            pending_read_buffer(),
                            pending_read_buffer_len(),
                            NULL,
                            &read_context_->overlapped);
       if (!ok && GetLastError() != ERROR_IO_PENDING) {
-        VPLOG(1) << "Read failed";
+        DVPLOG(1) << "Read failed";
         ReadCompleted(0, serial::RECEIVE_ERROR_SYSTEM_ERROR);
       }
     }
   } else if (context == read_context_) {
     if (read_canceled()) {
       ReadCompleted(bytes_transferred, read_cancel_reason());
     } else if (error != ERROR_SUCCESS && error != ERROR_OPERATION_ABORTED) {
       ReadCompleted(0, serial::RECEIVE_ERROR_SYSTEM_ERROR);
     } else {
       ReadCompleted(bytes_transferred,
@@ skipping 24 matching lines @@
                      error == ERROR_SUCCESS ? serial::SEND_ERROR_NONE
                                             : serial::SEND_ERROR_SYSTEM_ERROR);
     }
   } else {
     NOTREACHED() << "Invalid IOContext";
   }
 }
 
 bool SerialIoHandlerWin::Flush() const {
   if (!PurgeComm(file().GetPlatformFile(), PURGE_RXCLEAR | PURGE_TXCLEAR)) {
-    VPLOG(1) << "Failed to flush serial port";
+    DVPLOG(1) << "Failed to flush serial port";
     return false;
   }
   return true;
 }
 
 serial::DeviceControlSignalsPtr SerialIoHandlerWin::GetControlSignals() const {
   DWORD status;
   if (!GetCommModemStatus(file().GetPlatformFile(), &status)) {
-    VPLOG(1) << "Failed to get port control signals";
+    DVPLOG(1) << "Failed to get port control signals";
     return serial::DeviceControlSignalsPtr();
   }
 
   serial::DeviceControlSignalsPtr signals(serial::DeviceControlSignals::New());
   signals->dcd = (status & MS_RLSD_ON) != 0;
   signals->cts = (status & MS_CTS_ON) != 0;
   signals->dsr = (status & MS_DSR_ON) != 0;
   signals->ri = (status & MS_RING_ON) != 0;
   return signals.Pass();
 }
 
 bool SerialIoHandlerWin::SetControlSignals(
     const serial::HostControlSignals& signals) {
   if (signals.has_dtr) {
     if (!EscapeCommFunction(file().GetPlatformFile(),
                             signals.dtr ? SETDTR : CLRDTR)) {
-      VPLOG(1) << "Failed to configure DTR signal";
+      DVPLOG(1) << "Failed to configure DTR signal";
       return false;
     }
   }
   if (signals.has_rts) {
     if (!EscapeCommFunction(file().GetPlatformFile(),
                             signals.rts ? SETRTS : CLRRTS)) {
-      VPLOG(1) << "Failed to configure RTS signal";
+      DVPLOG(1) << "Failed to configure RTS signal";
       return false;
     }
   }
   return true;
 }
 
 serial::ConnectionInfoPtr SerialIoHandlerWin::GetPortInfo() const {
   DCB config = {0};
   config.DCBlength = sizeof(config);
   if (!GetCommState(file().GetPlatformFile(), &config)) {
-    VPLOG(1) << "Failed to get serial port info";
+    DVPLOG(1) << "Failed to get serial port info";
     return serial::ConnectionInfoPtr();
   }
   serial::ConnectionInfoPtr info(serial::ConnectionInfo::New());
   info->bitrate = SpeedConstantToBitrate(config.BaudRate);
   info->data_bits = DataBitsConstantToEnum(config.ByteSize);
   info->parity_bit = ParityBitConstantToEnum(config.Parity);
   info->stop_bits = StopBitsConstantToEnum(config.StopBits);
   info->cts_flow_control = config.fOutxCtsFlow != 0;
   return info.Pass();
 }
 
 bool SerialIoHandlerWin::SetBreak() {
   if (!SetCommBreak(file().GetPlatformFile())) {
-    VPLOG(1) << "Failed to set break";
+    DVPLOG(1) << "Failed to set break";
     return false;
   }
   return true;
 }
 
 bool SerialIoHandlerWin::ClearBreak() {
   if (!ClearCommBreak(file().GetPlatformFile())) {
-    VPLOG(1) << "Failed to clear break";
+    DVPLOG(1) << "Failed to clear break";
     return false;
   }
   return true;
 }
 
 std::string SerialIoHandler::MaybeFixUpPortName(const std::string& port_name) {
   // For COM numbers less than 9, CreateFile is called with a string such as
   // "COM1". For numbers greater than 9, a prefix of "\\\\.\\" must be added.
   if (port_name.length() > std::string("COM9").length())
     return std::string("\\\\.\\").append(port_name);
 
   return port_name;
 }
 
 }  // namespace device