UDP: Windows implementation using non-blocking IO

net/udp/udp_socket_win.cc

 // Copyright (c) 2012 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 "net/udp/udp_socket_win.h"
 
 #include <mstcpip.h>
 
 #include "base/basictypes.h"
 #include "base/callback.h"
@@ skipping 35 matching lines @@
  public:
   explicit Core(UDPSocketWin* socket);
 
   // Start watching for the end of a read or write operation.
   void WatchForRead();
   void WatchForWrite();
 
   // The UDPSocketWin is going away.
   void Detach() { socket_ = NULL; }
 
-  // The separate OVERLAPPED variables for asynchronous operation.
-  OVERLAPPED read_overlapped_;
-  OVERLAPPED write_overlapped_;
+  // Separate events for non-blocking IO operations.
+  WSAEVENT read_event_;
+  WSAEVENT write_event_;
 
   // The buffers used in Read() and Write().
   scoped_refptr<IOBuffer> read_iobuffer_;
   scoped_refptr<IOBuffer> write_iobuffer_;
+  int read_iobuffer_len_;

[rvargas (doing something else), 2015/01/21 22:10:09]

We are not supposed to have public variables. We should add set/getters as
needed.

[Alpha Left Google, 2015/01/22 01:01:25]

Done.

+  int write_iobuffer_len_;
+  bool non_blocking_reads_initialized_;
+  bool non_blocking_writes_initialized_;
 
   // The address storage passed to WSARecvFrom().
   SockaddrStorage recv_addr_storage_;
 
  private:
   friend class base::RefCounted<Core>;
 
   class ReadDelegate : public base::win::ObjectWatcher::Delegate {
    public:
     explicit ReadDelegate(Core* core) : core_(core) {}
@@ skipping 32 matching lines @@
   base::win::ObjectWatcher read_watcher_;
   // |write_watcher_| watches for events from Write();
   base::win::ObjectWatcher write_watcher_;
 
   DISALLOW_COPY_AND_ASSIGN(Core);
 };
 
 UDPSocketWin::Core::Core(UDPSocketWin* socket)
     : socket_(socket),
       reader_(this),
-      writer_(this) {
-  memset(&read_overlapped_, 0, sizeof(read_overlapped_));
-  memset(&write_overlapped_, 0, sizeof(write_overlapped_));
-
-  read_overlapped_.hEvent = WSACreateEvent();
-  write_overlapped_.hEvent = WSACreateEvent();
+      writer_(this),
+      read_iobuffer_len_(0),
+      write_iobuffer_len_(0),
+      non_blocking_reads_initialized_(false),
+      non_blocking_writes_initialized_(false) {
+  read_event_ = WSACreateEvent();
+  write_event_ = WSACreateEvent();
 }
 
 UDPSocketWin::Core::~Core() {
   // Make sure the message loop is not watching this object anymore.
   read_watcher_.StopWatching();
   write_watcher_.StopWatching();
 
-  WSACloseEvent(read_overlapped_.hEvent);
-  memset(&read_overlapped_, 0xaf, sizeof(read_overlapped_));
-  WSACloseEvent(write_overlapped_.hEvent);
-  memset(&write_overlapped_, 0xaf, sizeof(write_overlapped_));
+  WSACloseEvent(read_event_);
+  WSACloseEvent(write_event_);
 }
 
 void UDPSocketWin::Core::WatchForRead() {
   // We grab an extra reference because there is an IO operation in progress.
   // Balanced in ReadDelegate::OnObjectSignaled().
   AddRef();
-  read_watcher_.StartWatching(read_overlapped_.hEvent, &reader_);
+  read_watcher_.StartWatching(read_event_, &reader_);
 }
 
 void UDPSocketWin::Core::WatchForWrite() {
   // We grab an extra reference because there is an IO operation in progress.
   // Balanced in WriteDelegate::OnObjectSignaled().
   AddRef();
-  write_watcher_.StartWatching(write_overlapped_.hEvent, &writer_);
+  write_watcher_.StartWatching(write_event_, &writer_);
 }
 
 void UDPSocketWin::Core::ReadDelegate::OnObjectSignaled(HANDLE object) {
   // TODO(vadimt): Remove ScopedTracker below once crbug.com/418183 is fixed.
   tracked_objects::ScopedTracker tracking_profile(
       FROM_HERE_WITH_EXPLICIT_FUNCTION(
           "UDPSocketWin_Core_ReadDelegate_OnObjectSignaled"));
 
-  DCHECK_EQ(object, core_->read_overlapped_.hEvent);
+  DCHECK_EQ(object, core_->read_event_);
   if (core_->socket_)
     core_->socket_->DidCompleteRead();
 
   core_->Release();
 }
 
 void UDPSocketWin::Core::WriteDelegate::OnObjectSignaled(HANDLE object) {
   // TODO(vadimt): Remove ScopedTracker below once crbug.com/418183 is fixed.
   tracked_objects::ScopedTracker tracking_profile(
       FROM_HERE_WITH_EXPLICIT_FUNCTION(
           "UDPSocketWin_Core_WriteDelegate_OnObjectSignaled"));
 
-  DCHECK_EQ(object, core_->write_overlapped_.hEvent);
+  DCHECK_EQ(object, core_->write_event_);
   if (core_->socket_)
     core_->socket_->DidCompleteWrite();
 
   core_->Release();
 }
 //-----------------------------------------------------------------------------
 
 QwaveAPI::QwaveAPI() : qwave_supported_(false) {
   HMODULE qwave = LoadLibrary(L"qwave.dll");
   if (!qwave)
@@ skipping 382 matching lines @@
   DCHECK_NE(rv, ERR_IO_PENDING);
   DCHECK(!write_callback_.is_null());
 
   // since Run may result in Write being called, clear write_callback_ up front.
   CompletionCallback c = write_callback_;
   write_callback_.Reset();
   c.Run(rv);
 }
 
 void UDPSocketWin::DidCompleteRead() {
-  DWORD num_bytes, flags;
-  BOOL ok = WSAGetOverlappedResult(socket_, &core_->read_overlapped_,
-                                   &num_bytes, FALSE, &flags);
-  WSAResetEvent(core_->read_overlapped_.hEvent);
-  int result = ok ? num_bytes : MapSystemError(WSAGetLastError());
-  // Convert address.
-  if (recv_from_address_ && result >= 0) {
+  WSANETWORKEVENTS network_events;
+  int os_error = 0;
+  int rv = WSAEnumNetworkEvents(socket_, core_->read_event_, &network_events);
+  if (rv == SOCKET_ERROR) {
+    os_error = WSAGetLastError();
+    rv = MapSystemError(os_error);
+    DoReadCallback(rv);
+    return;
+  } else if (network_events.lNetworkEvents) {

[Ryan Hamilton, 2015/01/21 04:03:35]

nit: since there was a return in the previous block, you can drop the else.

[Alpha Left Google, 2015/01/22 01:01:25]

Done.

+    DCHECK(network_events.lNetworkEvents & FD_READ);
+    // If network_events.iErrorCode[FD_READ_BIT] is nonzero, still call
+    // InternalRecvFrom() because it reports a more accurate error code.
+    rv = InternalRecvFrom(core_->read_iobuffer_.get(),
+                          core_->read_iobuffer_len_, recv_from_address_);
+    if (rv == ERR_IO_PENDING)
+      return;
+  } else {
+    core_->WatchForRead();

[Ryan Hamilton, 2015/01/21 04:03:35]

Out of curiosity, what conditions lead to this branch?

[Alpha Left Google, 2015/01/22 01:01:26]

This comes from tcp_socket_win.cc.

The comment there reads:
    // This may happen because Read() may succeed synchronously and
    // consume all the received data without resetting the event object.

Interestingly tcp_socket_win uses non-blocking IO for read but overlapped IO for
write..

+    return;
+  }
+  // Convert address if there's data received.
+  if (recv_from_address_ && rv >= 0) {
     if (!ReceiveAddressToIPEndpoint(recv_from_address_))
-      result = ERR_ADDRESS_INVALID;
+      rv = ERR_ADDRESS_INVALID;
   }
-  LogRead(result, core_->read_iobuffer_->data());
+  LogRead(rv, core_->read_iobuffer_->data());
   core_->read_iobuffer_ = NULL;
+  core_->read_iobuffer_len_ = 0;
   recv_from_address_ = NULL;
-  DoReadCallback(result);
+  DoReadCallback(rv);
 }
 
 void UDPSocketWin::LogRead(int result, const char* bytes) const {
   if (result < 0) {
     net_log_.AddEventWithNetErrorCode(NetLog::TYPE_UDP_RECEIVE_ERROR, result);
     return;
   }
 
   if (net_log_.IsLogging()) {
     // Get address for logging, if |address| is NULL.
     IPEndPoint address;
     bool is_address_valid = ReceiveAddressToIPEndpoint(&address);
     net_log_.AddEvent(
         NetLog::TYPE_UDP_BYTES_RECEIVED,
         CreateNetLogUDPDataTranferCallback(
             result, bytes,
             is_address_valid ? &address : NULL));
   }
 
   base::StatsCounter read_bytes("udp.read_bytes");
   read_bytes.Add(result);
   NetworkActivityMonitor::GetInstance()->IncrementBytesReceived(result);
 }
 
 void UDPSocketWin::DidCompleteWrite() {
-  DWORD num_bytes, flags;
-  BOOL ok = WSAGetOverlappedResult(socket_, &core_->write_overlapped_,
-                                   &num_bytes, FALSE, &flags);
-  WSAResetEvent(core_->write_overlapped_.hEvent);
-  int result = ok ? num_bytes : MapSystemError(WSAGetLastError());
-  LogWrite(result, core_->write_iobuffer_->data(), send_to_address_.get());
-
+  WSANETWORKEVENTS network_events;
+  int os_error = 0;
+  int rv = WSAEnumNetworkEvents(socket_, core_->write_event_, &network_events);
+  if (rv == SOCKET_ERROR) {
+    os_error = WSAGetLastError();
+    rv = MapSystemError(os_error);
+    DoWriteCallback(rv);
+    return;
+  } else if (network_events.lNetworkEvents) {
+    DCHECK(network_events.lNetworkEvents & FD_WRITE);
+    // If network_events.iErrorCode[FD_WRITE_BIT] is nonzero, still call
+    // InternalSendto() because it reports a more accurate error code.
+    rv = InternalSendTo(core_->write_iobuffer_.get(),
+                        core_->write_iobuffer_len_, send_to_address_.get());
+    if (rv == ERR_IO_PENDING)
+      return;
+  } else {
+    core_->WatchForWrite();
+    return;
+  }
+  LogWrite(rv, core_->write_iobuffer_->data(), send_to_address_.get());
+  core_->write_iobuffer_ = NULL;
+  core_->write_iobuffer_len_ = 0;
   send_to_address_.reset();
-  core_->write_iobuffer_ = NULL;
-  DoWriteCallback(result);
+  DoWriteCallback(rv);
 }
 
 void UDPSocketWin::LogWrite(int result,
                             const char* bytes,
                             const IPEndPoint* address) const {
   if (result < 0) {
     net_log_.AddEventWithNetErrorCode(NetLog::TYPE_UDP_SEND_ERROR, result);
     return;
   }
 
   if (net_log_.IsLogging()) {
     net_log_.AddEvent(
         NetLog::TYPE_UDP_BYTES_SENT,
         CreateNetLogUDPDataTranferCallback(result, bytes, address));
   }
 
   base::StatsCounter write_bytes("udp.write_bytes");
   write_bytes.Add(result);
   NetworkActivityMonitor::GetInstance()->IncrementBytesSent(result);
 }
 
 int UDPSocketWin::InternalRecvFrom(IOBuffer* buf, int buf_len,
                                    IPEndPoint* address) {
-  DCHECK(!core_->read_iobuffer_.get());
+  if (!core_->non_blocking_reads_initialized_) {
+    // After this call we'll receive FD_READ signals when asynchronous read

[rvargas (doing something else), 2015/01/21 22:10:09]

nit: after this call the event will be signaled 

[Alpha Left Google, 2015/01/22 01:01:25]

Done.

+    // is completed.
+    WSAEventSelect(socket_, core_->read_event_, FD_READ);
+    core_->non_blocking_reads_initialized_ = true;
+  }
   SockaddrStorage& storage = core_->recv_addr_storage_;
   storage.addr_len = sizeof(storage.addr_storage);
 
   WSABUF read_buffer;
   read_buffer.buf = buf->data();
   read_buffer.len = buf_len;
 
   DWORD flags = 0;
-  DWORD num;
+  DWORD bytes_read;
   CHECK_NE(INVALID_SOCKET, socket_);
-  AssertEventNotSignaled(core_->read_overlapped_.hEvent);
-  int rv = WSARecvFrom(socket_, &read_buffer, 1, &num, &flags, storage.addr,
-                       &storage.addr_len, &core_->read_overlapped_, NULL);
-  if (rv == 0) {
-    if (ResetEventIfSignaled(core_->read_overlapped_.hEvent)) {
-      int result = num;
-      // Convert address.
-      if (address && result >= 0) {
-        if (!ReceiveAddressToIPEndpoint(address))
-          result = ERR_ADDRESS_INVALID;
-      }
-      LogRead(result, buf->data());
-      return result;
+  int rv = WSARecvFrom(socket_, &read_buffer, 1, &bytes_read, &flags,

[rvargas (doing something else), 2015/01/21 22:10:09]

Looks like there's no reason to use WSARecvFrom over recvfrom

[Alpha Left Google, 2015/01/22 01:01:25]

Done.

+                       storage.addr, &storage.addr_len, NULL, NULL);
+  if (rv == SOCKET_ERROR) {
+    int os_error = WSAGetLastError();
+    if (os_error != WSAEWOULDBLOCK) {
+      rv = MapSystemError(os_error);
+      LogRead(rv, NULL);
+      return rv;
     }
   } else {
-    int os_error = WSAGetLastError();
-    if (os_error != WSA_IO_PENDING) {
-      int result = MapSystemError(os_error);
-      LogRead(result, NULL);
-      return result;
+    rv = bytes_read;
+    // Convert address.
+    if (address && rv >= 0 && !ReceiveAddressToIPEndpoint(address)) {
+      rv = ERR_ADDRESS_INVALID;
     }
+    LogRead(rv, buf->data());
+    return rv;
   }
   core_->WatchForRead();
   core_->read_iobuffer_ = buf;
+  core_->read_iobuffer_len_ = buf_len;
   return ERR_IO_PENDING;
 }
 
 int UDPSocketWin::InternalSendTo(IOBuffer* buf, int buf_len,
                                  const IPEndPoint* address) {
-  DCHECK(!core_->write_iobuffer_.get());
+  if (!core_->non_blocking_writes_initialized_) {
+    // After this call we'll receive FD_WRITE signals when asynchronous write
+    // is completed.
+    WSAEventSelect(socket_, core_->write_event_, FD_WRITE);
+    core_->non_blocking_writes_initialized_ = true;
+  }
   SockaddrStorage storage;
   struct sockaddr* addr = storage.addr;
   // Convert address.
   if (!address) {
     addr = NULL;
     storage.addr_len = 0;
   } else {
     if (!address->ToSockAddr(addr, &storage.addr_len)) {
       int result = ERR_ADDRESS_INVALID;
       LogWrite(result, NULL, NULL);
       return result;
     }
   }
 
   WSABUF write_buffer;
   write_buffer.buf = buf->data();
   write_buffer.len = buf_len;
 
   DWORD flags = 0;
-  DWORD num;
-  AssertEventNotSignaled(core_->write_overlapped_.hEvent);
-  int rv = WSASendTo(socket_, &write_buffer, 1, &num, flags,
-                     addr, storage.addr_len, &core_->write_overlapped_, NULL);
-  if (rv == 0) {
-    if (ResetEventIfSignaled(core_->write_overlapped_.hEvent)) {
-      int result = num;
-      LogWrite(result, buf->data(), address);
-      return result;
+  DWORD bytes_written;
+  int rv = WSASendTo(socket_, &write_buffer, 1, &bytes_written, flags, addr,
+                     storage.addr_len, NULL, NULL);
+  if (rv == SOCKET_ERROR) {
+    int os_error = WSAGetLastError();
+    if (os_error != WSAEWOULDBLOCK) {
+      rv = MapSystemError(os_error);
+      LogWrite(rv, NULL, NULL);
+      return rv;
     }
   } else {
-    int os_error = WSAGetLastError();
-    if (os_error != WSA_IO_PENDING) {
-      int result = MapSystemError(os_error);
-      LogWrite(result, NULL, NULL);
-      return result;
-    }
+    rv = bytes_written;
+    LogWrite(rv, buf->data(), address);
+    return rv;
   }
-
   core_->WatchForWrite();
   core_->write_iobuffer_ = buf;
+  core_->write_iobuffer_len_ = buf_len;
   return ERR_IO_PENDING;
 }
 
 int UDPSocketWin::SetMulticastOptions() {
   if (!(socket_options_ & SOCKET_OPTION_MULTICAST_LOOP)) {
     DWORD loop = 0;
     int protocol_level =
         addr_family_ == AF_INET ? IPPROTO_IP : IPPROTO_IPV6;
     int option =
         addr_family_ == AF_INET ? IP_MULTICAST_LOOP: IPV6_MULTICAST_LOOP;
@@ skipping 277 matching lines @@
               NULL);
 
   return OK;
 }
 
 void UDPSocketWin::DetachFromThread() {
   base::NonThreadSafe::DetachFromThread();
 }
 
 }  // namespace net