Pulled a significant portion of Socket implementation into BaseSocket in order to prepare for the s…

runtime/bin/socket_base_linux.cc

 // Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 #if !defined(DART_IO_DISABLED)
 
 #include "platform/globals.h"
 #if defined(HOST_OS_LINUX)
 
 #include "bin/socket.h"

[zra, 2017/04/03 20:30:34]

ditto

-#include "bin/socket_linux.h"
+#include "bin/socket_base_linux.h"
 
 #include <errno.h>        // NOLINT
 #include <ifaddrs.h>      // NOLINT
 #include <net/if.h>       // NOLINT
 #include <netinet/tcp.h>  // NOLINT
 #include <stdio.h>        // NOLINT
 #include <stdlib.h>       // NOLINT
 #include <string.h>       // NOLINT
 #include <sys/stat.h>     // NOLINT
 #include <unistd.h>       // NOLINT
 
 #include "bin/fdutils.h"
 #include "bin/file.h"
 #include "bin/thread.h"
 #include "platform/signal_blocker.h"
 
 namespace dart {
 namespace bin {
 
 SocketAddress::SocketAddress(struct sockaddr* sa) {
   ASSERT(INET6_ADDRSTRLEN >= INET_ADDRSTRLEN);
-  if (!Socket::FormatNumericAddress(*reinterpret_cast<RawAddr*>(sa), as_string_,
-                                    INET6_ADDRSTRLEN)) {
+  if (!SocketBase::FormatNumericAddress(*reinterpret_cast<RawAddr*>(sa),
+                                        as_string_, INET6_ADDRSTRLEN)) {
     as_string_[0] = 0;
   }
   socklen_t salen = GetAddrLength(*reinterpret_cast<RawAddr*>(sa));
   memmove(reinterpret_cast<void*>(&addr_), sa, salen);
 }
 
 
-bool Socket::FormatNumericAddress(const RawAddr& addr, char* address, int len) {
+bool SocketBase::FormatNumericAddress(const RawAddr& addr,
+                                      char* address,
+                                      int len) {
   socklen_t salen = SocketAddress::GetAddrLength(addr);
   return (NO_RETRY_EXPECTED(getnameinfo(&addr.addr, salen, address, len, NULL,
                                         0, NI_NUMERICHOST) == 0));
 }
 
 
-Socket::Socket(intptr_t fd)
-    : ReferenceCounted(), fd_(fd), port_(ILLEGAL_PORT) {}
-
-
-void Socket::SetClosedFd() {
-  fd_ = kClosedFd;
-}
-
-
-bool Socket::Initialize() {
-  // Nothing to do on Linux.
-  return true;
-}
-
-
-static intptr_t Create(const RawAddr& addr) {
-  intptr_t fd;
-  fd = NO_RETRY_EXPECTED(
-      socket(addr.ss.ss_family, SOCK_STREAM | SOCK_NONBLOCK | SOCK_CLOEXEC, 0));
-  if (fd < 0) {
-    return -1;
-  }
-  return fd;
-}
-
-
-static intptr_t Connect(intptr_t fd, const RawAddr& addr) {
-  intptr_t result = TEMP_FAILURE_RETRY(
-      connect(fd, &addr.addr, SocketAddress::GetAddrLength(addr)));
-  if ((result == 0) || (errno == EINPROGRESS)) {
-    return fd;
-  }
-  FDUtils::FDUtils::SaveErrorAndClose(fd);
-  return -1;
-}
-
-
-intptr_t Socket::CreateConnect(const RawAddr& addr) {
-  intptr_t fd = Create(addr);
-  if (fd < 0) {
-    return fd;
-  }
-  return Connect(fd, addr);
-}
-
-
-intptr_t Socket::CreateBindConnect(const RawAddr& addr,
-                                   const RawAddr& source_addr) {
-  intptr_t fd = Create(addr);
-  if (fd < 0) {
-    return fd;
-  }
-
-  intptr_t result = TEMP_FAILURE_RETRY(
-      bind(fd, &source_addr.addr, SocketAddress::GetAddrLength(source_addr)));
-  if ((result != 0) && (errno != EINPROGRESS)) {
-    FDUtils::SaveErrorAndClose(fd);
-    return -1;
-  }
-
-  return Connect(fd, addr);
-}
-
-
-bool Socket::IsBindError(intptr_t error_number) {
+bool SocketBase::IsBindError(intptr_t error_number) {
   return error_number == EADDRINUSE || error_number == EADDRNOTAVAIL ||
          error_number == EINVAL;
 }
 
 
-intptr_t Socket::Available(intptr_t fd) {
+intptr_t SocketBase::Available(intptr_t fd) {
   return FDUtils::AvailableBytes(fd);
 }
 
 
-intptr_t Socket::Read(intptr_t fd, void* buffer, intptr_t num_bytes) {
+intptr_t SocketBase::Read(intptr_t fd, void* buffer, intptr_t num_bytes) {
   ASSERT(fd >= 0);
   ssize_t read_bytes = TEMP_FAILURE_RETRY(read(fd, buffer, num_bytes));
   ASSERT(EAGAIN == EWOULDBLOCK);
   if ((read_bytes == -1) && (errno == EWOULDBLOCK)) {
     // If the read would block we need to retry and therefore return 0
     // as the number of bytes written.
     read_bytes = 0;
   }
   return read_bytes;
 }
 
 
-intptr_t Socket::RecvFrom(intptr_t fd,
-                          void* buffer,
-                          intptr_t num_bytes,
-                          RawAddr* addr) {
+intptr_t SocketBase::RecvFrom(intptr_t fd,
+                              void* buffer,
+                              intptr_t num_bytes,
+                              RawAddr* addr) {
   ASSERT(fd >= 0);
   socklen_t addr_len = sizeof(addr->ss);
   ssize_t read_bytes = TEMP_FAILURE_RETRY(
       recvfrom(fd, buffer, num_bytes, 0, &addr->addr, &addr_len));
   if ((read_bytes == -1) && (errno == EWOULDBLOCK)) {
     // If the read would block we need to retry and therefore return 0
     // as the number of bytes written.
     read_bytes = 0;
   }
   return read_bytes;
 }
 
 
-intptr_t Socket::Write(intptr_t fd, const void* buffer, intptr_t num_bytes) {
+intptr_t SocketBase::Write(intptr_t fd,
+                           const void* buffer,
+                           intptr_t num_bytes) {
   ASSERT(fd >= 0);
   ssize_t written_bytes = TEMP_FAILURE_RETRY(write(fd, buffer, num_bytes));
   ASSERT(EAGAIN == EWOULDBLOCK);
   if ((written_bytes == -1) && (errno == EWOULDBLOCK)) {
     // If the would block we need to retry and therefore return 0 as
     // the number of bytes written.
     written_bytes = 0;
   }
   return written_bytes;
 }
 
 
-intptr_t Socket::SendTo(intptr_t fd,
-                        const void* buffer,
-                        intptr_t num_bytes,
-                        const RawAddr& addr) {
+intptr_t SocketBase::SendTo(intptr_t fd,
+                            const void* buffer,
+                            intptr_t num_bytes,
+                            const RawAddr& addr) {
   ASSERT(fd >= 0);
   ssize_t written_bytes =
       TEMP_FAILURE_RETRY(sendto(fd, buffer, num_bytes, 0, &addr.addr,
                                 SocketAddress::GetAddrLength(addr)));
   ASSERT(EAGAIN == EWOULDBLOCK);
   if ((written_bytes == -1) && (errno == EWOULDBLOCK)) {
     // If the would block we need to retry and therefore return 0 as
     // the number of bytes written.
     written_bytes = 0;
   }
   return written_bytes;
 }
 
 
-intptr_t Socket::GetPort(intptr_t fd) {
+intptr_t SocketBase::GetPort(intptr_t fd) {
   ASSERT(fd >= 0);
   RawAddr raw;
   socklen_t size = sizeof(raw);
   if (NO_RETRY_EXPECTED(getsockname(fd, &raw.addr, &size))) {
     return 0;
   }
   return SocketAddress::GetAddrPort(raw);
 }
 
 
-SocketAddress* Socket::GetRemotePeer(intptr_t fd, intptr_t* port) {
+SocketAddress* SocketBase::GetRemotePeer(intptr_t fd, intptr_t* port) {
   ASSERT(fd >= 0);
   RawAddr raw;
   socklen_t size = sizeof(raw);
   if (NO_RETRY_EXPECTED(getpeername(fd, &raw.addr, &size))) {
     return NULL;
   }
   *port = SocketAddress::GetAddrPort(raw);
   return new SocketAddress(&raw.addr);
 }
 
 
-void Socket::GetError(intptr_t fd, OSError* os_error) {
+void SocketBase::GetError(intptr_t fd, OSError* os_error) {
   int len = sizeof(errno);
   int err = 0;
   VOID_NO_RETRY_EXPECTED(getsockopt(fd, SOL_SOCKET, SO_ERROR, &err,
                                     reinterpret_cast<socklen_t*>(&len)));
   errno = err;
   os_error->SetCodeAndMessage(OSError::kSystem, errno);
 }
 
 
-int Socket::GetType(intptr_t fd) {
+int SocketBase::GetType(intptr_t fd) {
   struct stat64 buf;
   int result = TEMP_FAILURE_RETRY(fstat64(fd, &buf));
   if (result == -1) {
     return -1;
   }
   if (S_ISCHR(buf.st_mode)) {
     return File::kTerminal;
   }
   if (S_ISFIFO(buf.st_mode)) {
     return File::kPipe;
   }
   if (S_ISREG(buf.st_mode)) {
     return File::kFile;
   }
   return File::kOther;
 }
 
 
-intptr_t Socket::GetStdioHandle(intptr_t num) {
+intptr_t SocketBase::GetStdioHandle(intptr_t num) {
   return num;
 }
 
 
-AddressList<SocketAddress>* Socket::LookupAddress(const char* host,
-                                                  int type,
-                                                  OSError** os_error) {
+AddressList<SocketAddress>* SocketBase::LookupAddress(const char* host,
+                                                      int type,
+                                                      OSError** os_error) {
   // Perform a name lookup for a host name.
   struct addrinfo hints;
   memset(&hints, 0, sizeof(hints));
   hints.ai_family = SocketAddress::FromType(type);
   hints.ai_socktype = SOCK_STREAM;
   hints.ai_flags = AI_ADDRCONFIG;
   hints.ai_protocol = IPPROTO_TCP;
   struct addrinfo* info = NULL;
   int status = NO_RETRY_EXPECTED(getaddrinfo(host, 0, &hints, &info));
   if (status != 0) {
@@ skipping 20 matching lines @@
     if ((c->ai_family == AF_INET) || (c->ai_family == AF_INET6)) {
       addresses->SetAt(i, new SocketAddress(c->ai_addr));
       i++;
     }
   }
   freeaddrinfo(info);
   return addresses;
 }
 
 
-bool Socket::ReverseLookup(const RawAddr& addr,
-                           char* host,
-                           intptr_t host_len,
-                           OSError** os_error) {
+bool SocketBase::ReverseLookup(const RawAddr& addr,
+                               char* host,
+                               intptr_t host_len,
+                               OSError** os_error) {
   ASSERT(host_len >= NI_MAXHOST);
   int status = NO_RETRY_EXPECTED(
       getnameinfo(&addr.addr, SocketAddress::GetAddrLength(addr), host,
                   host_len, NULL, 0, NI_NAMEREQD));
   if (status != 0) {
     ASSERT(*os_error == NULL);
     *os_error =
         new OSError(status, gai_strerror(status), OSError::kGetAddressInfo);
     return false;
   }
   return true;
 }
 
 
-bool Socket::ParseAddress(int type, const char* address, RawAddr* addr) {
+bool SocketBase::ParseAddress(int type, const char* address, RawAddr* addr) {
   int result;
   if (type == SocketAddress::TYPE_IPV4) {
     result = NO_RETRY_EXPECTED(inet_pton(AF_INET, address, &addr->in.sin_addr));
   } else {
     ASSERT(type == SocketAddress::TYPE_IPV6);
     result =
         NO_RETRY_EXPECTED(inet_pton(AF_INET6, address, &addr->in6.sin6_addr));
   }
   return (result == 1);
 }
 
 
-intptr_t Socket::CreateBindDatagram(const RawAddr& addr, bool reuseAddress) {
-  intptr_t fd;
-
-  fd = NO_RETRY_EXPECTED(socket(addr.addr.sa_family,
-                                SOCK_DGRAM | SOCK_CLOEXEC | SOCK_NONBLOCK,
-                                IPPROTO_UDP));
-  if (fd < 0) {
-    return -1;
-  }
-
-  if (reuseAddress) {
-    int optval = 1;
-    VOID_NO_RETRY_EXPECTED(
-        setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof(optval)));
-  }
-
-  if (NO_RETRY_EXPECTED(
-          bind(fd, &addr.addr, SocketAddress::GetAddrLength(addr))) < 0) {
-    FDUtils::SaveErrorAndClose(fd);
-    return -1;
-  }
-  return fd;
-}
-
-
 static bool ShouldIncludeIfaAddrs(struct ifaddrs* ifa, int lookup_family) {
   if (ifa->ifa_addr == NULL) {
     // OpenVPN's virtual device tun0.
     return false;
   }
   int family = ifa->ifa_addr->sa_family;
   return ((lookup_family == family) ||
           (((lookup_family == AF_UNSPEC) &&
             ((family == AF_INET) || (family == AF_INET6)))));
 }
 
 
-bool Socket::ListInterfacesSupported() {
+bool SocketBase::ListInterfacesSupported() {
   return true;
 }
 
 
-AddressList<InterfaceSocketAddress>* Socket::ListInterfaces(
+AddressList<InterfaceSocketAddress>* SocketBase::ListInterfaces(
     int type,
     OSError** os_error) {
   struct ifaddrs* ifaddr;
 
   int status = NO_RETRY_EXPECTED(getifaddrs(&ifaddr));
   if (status != 0) {
     ASSERT(*os_error == NULL);
     *os_error =
         new OSError(status, gai_strerror(status), OSError::kGetAddressInfo);
     return NULL;
@@ skipping 18 matching lines @@
           i, new InterfaceSocketAddress(ifa->ifa_addr, ifa_name,
                                         if_nametoindex(ifa->ifa_name)));
       i++;
     }
   }
   freeifaddrs(ifaddr);
   return addresses;
 }
 
 
-intptr_t ServerSocket::CreateBindListen(const RawAddr& addr,
-                                        intptr_t backlog,
-                                        bool v6_only) {
-  intptr_t fd;
-
-  fd = NO_RETRY_EXPECTED(
-      socket(addr.ss.ss_family, SOCK_STREAM | SOCK_CLOEXEC | SOCK_NONBLOCK, 0));
-  if (fd < 0) {
-    return -1;
-  }
-
-  int optval = 1;
-  VOID_NO_RETRY_EXPECTED(
-      setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &optval, sizeof(optval)));
-
-  if (addr.ss.ss_family == AF_INET6) {
-    optval = v6_only ? 1 : 0;
-    VOID_NO_RETRY_EXPECTED(
-        setsockopt(fd, IPPROTO_IPV6, IPV6_V6ONLY, &optval, sizeof(optval)));
-  }
-
-  if (NO_RETRY_EXPECTED(
-          bind(fd, &addr.addr, SocketAddress::GetAddrLength(addr))) < 0) {
-    FDUtils::SaveErrorAndClose(fd);
-    return -1;
-  }
-
-  // Test for invalid socket port 65535 (some browsers disallow it).
-  if ((SocketAddress::GetAddrPort(addr) == 0) &&
-      (Socket::GetPort(fd) == 65535)) {
-    // Don't close the socket until we have created a new socket, ensuring
-    // that we do not get the bad port number again.
-    intptr_t new_fd = CreateBindListen(addr, backlog, v6_only);
-    FDUtils::SaveErrorAndClose(fd);
-    return new_fd;
-  }
-
-  if (NO_RETRY_EXPECTED(listen(fd, backlog > 0 ? backlog : SOMAXCONN)) != 0) {
-    FDUtils::SaveErrorAndClose(fd);
-    return -1;
-  }
-
-  return fd;
-}
-
-
-bool ServerSocket::StartAccept(intptr_t fd) {
-  USE(fd);
-  return true;
-}
-
-
-static bool IsTemporaryAcceptError(int error) {
-  // On Linux a number of protocol errors should be treated as EAGAIN.
-  // These are the ones for TCP/IP.
-  return (error == EAGAIN) || (error == ENETDOWN) || (error == EPROTO) ||
-         (error == ENOPROTOOPT) || (error == EHOSTDOWN) || (error == ENONET) ||
-         (error == EHOSTUNREACH) || (error == EOPNOTSUPP) ||
-         (error == ENETUNREACH);
-}
-
-
-intptr_t ServerSocket::Accept(intptr_t fd) {
-  intptr_t socket;
-  struct sockaddr clientaddr;
-  socklen_t addrlen = sizeof(clientaddr);
-  socket = TEMP_FAILURE_RETRY(accept(fd, &clientaddr, &addrlen));
-  if (socket == -1) {
-    if (IsTemporaryAcceptError(errno)) {
-      // We need to signal to the caller that this is actually not an
-      // error. We got woken up from the poll on the listening socket,
-      // but there is no connection ready to be accepted.
-      ASSERT(kTemporaryFailure != -1);
-      socket = kTemporaryFailure;
-    }
-  } else {
-    if (!FDUtils::SetCloseOnExec(socket)) {
-      FDUtils::SaveErrorAndClose(socket);
-      return -1;
-    }
-    if (!FDUtils::SetNonBlocking(socket)) {
-      FDUtils::SaveErrorAndClose(socket);
-      return -1;
-    }
-  }
-  return socket;
-}
-
-
-void Socket::Close(intptr_t fd) {
+void SocketBase::Close(intptr_t fd) {
   ASSERT(fd >= 0);
   VOID_TEMP_FAILURE_RETRY(close(fd));
 }
 
 
-bool Socket::GetNoDelay(intptr_t fd, bool* enabled) {
+bool SocketBase::GetNoDelay(intptr_t fd, bool* enabled) {
   int on;
   socklen_t len = sizeof(on);
   int err = NO_RETRY_EXPECTED(getsockopt(fd, IPPROTO_TCP, TCP_NODELAY,
                                          reinterpret_cast<void*>(&on), &len));
   if (err == 0) {
     *enabled = (on == 1);
   }
   return (err == 0);
 }
 
 
-bool Socket::SetNoDelay(intptr_t fd, bool enabled) {
+bool SocketBase::SetNoDelay(intptr_t fd, bool enabled) {
   int on = enabled ? 1 : 0;
   return NO_RETRY_EXPECTED(setsockopt(fd, IPPROTO_TCP, TCP_NODELAY,
                                       reinterpret_cast<char*>(&on),
                                       sizeof(on))) == 0;
 }
 
 
-bool Socket::GetMulticastLoop(intptr_t fd, intptr_t protocol, bool* enabled) {
+bool SocketBase::GetMulticastLoop(intptr_t fd,
+                                  intptr_t protocol,
+                                  bool* enabled) {
   uint8_t on;
   socklen_t len = sizeof(on);
   int level = protocol == SocketAddress::TYPE_IPV4 ? IPPROTO_IP : IPPROTO_IPV6;
   int optname = protocol == SocketAddress::TYPE_IPV4 ? IP_MULTICAST_LOOP
                                                      : IPV6_MULTICAST_LOOP;
   if (NO_RETRY_EXPECTED(getsockopt(fd, level, optname,
                                    reinterpret_cast<char*>(&on), &len)) == 0) {
     *enabled = (on == 1);
     return true;
   }
   return false;
 }
 
 
-bool Socket::SetMulticastLoop(intptr_t fd, intptr_t protocol, bool enabled) {
+bool SocketBase::SetMulticastLoop(intptr_t fd,
+                                  intptr_t protocol,
+                                  bool enabled) {
   int on = enabled ? 1 : 0;
   int level = protocol == SocketAddress::TYPE_IPV4 ? IPPROTO_IP : IPPROTO_IPV6;
   int optname = protocol == SocketAddress::TYPE_IPV4 ? IP_MULTICAST_LOOP
                                                      : IPV6_MULTICAST_LOOP;
   return NO_RETRY_EXPECTED(setsockopt(
              fd, level, optname, reinterpret_cast<char*>(&on), sizeof(on))) ==
          0;
 }
 
 
-bool Socket::GetMulticastHops(intptr_t fd, intptr_t protocol, int* value) {
+bool SocketBase::GetMulticastHops(intptr_t fd, intptr_t protocol, int* value) {
   uint8_t v;
   socklen_t len = sizeof(v);
   int level = protocol == SocketAddress::TYPE_IPV4 ? IPPROTO_IP : IPPROTO_IPV6;
   int optname = protocol == SocketAddress::TYPE_IPV4 ? IP_MULTICAST_TTL
                                                      : IPV6_MULTICAST_HOPS;
   if (NO_RETRY_EXPECTED(getsockopt(fd, level, optname,
                                    reinterpret_cast<char*>(&v), &len)) == 0) {
     *value = v;
     return true;
   }
   return false;
 }
 
 
-bool Socket::SetMulticastHops(intptr_t fd, intptr_t protocol, int value) {
+bool SocketBase::SetMulticastHops(intptr_t fd, intptr_t protocol, int value) {
   int v = value;
   int level = protocol == SocketAddress::TYPE_IPV4 ? IPPROTO_IP : IPPROTO_IPV6;
   int optname = protocol == SocketAddress::TYPE_IPV4 ? IP_MULTICAST_TTL
                                                      : IPV6_MULTICAST_HOPS;
   return NO_RETRY_EXPECTED(setsockopt(
              fd, level, optname, reinterpret_cast<char*>(&v), sizeof(v))) == 0;
 }
 
 
-bool Socket::GetBroadcast(intptr_t fd, bool* enabled) {
+bool SocketBase::GetBroadcast(intptr_t fd, bool* enabled) {
   int on;
   socklen_t len = sizeof(on);
   int err = NO_RETRY_EXPECTED(getsockopt(fd, SOL_SOCKET, SO_BROADCAST,
                                          reinterpret_cast<char*>(&on), &len));
   if (err == 0) {
     *enabled = (on == 1);
   }
   return (err == 0);
 }
 
 
-bool Socket::SetBroadcast(intptr_t fd, bool enabled) {
+bool SocketBase::SetBroadcast(intptr_t fd, bool enabled) {
   int on = enabled ? 1 : 0;
   return NO_RETRY_EXPECTED(setsockopt(fd, SOL_SOCKET, SO_BROADCAST,
                                       reinterpret_cast<char*>(&on),
                                       sizeof(on))) == 0;
 }
 
 
-bool Socket::JoinMulticast(intptr_t fd,
-                           const RawAddr& addr,
-                           const RawAddr&,
-                           int interfaceIndex) {
+bool SocketBase::JoinMulticast(intptr_t fd,
+                               const RawAddr& addr,
+                               const RawAddr&,
+                               int interfaceIndex) {
   int proto = addr.addr.sa_family == AF_INET ? IPPROTO_IP : IPPROTO_IPV6;
   struct group_req mreq;
   mreq.gr_interface = interfaceIndex;
   memmove(&mreq.gr_group, &addr.ss, SocketAddress::GetAddrLength(addr));
   return NO_RETRY_EXPECTED(
              setsockopt(fd, proto, MCAST_JOIN_GROUP, &mreq, sizeof(mreq))) == 0;
 }
 
 
-bool Socket::LeaveMulticast(intptr_t fd,
-                            const RawAddr& addr,
-                            const RawAddr&,
-                            int interfaceIndex) {
+bool SocketBase::LeaveMulticast(intptr_t fd,
+                                const RawAddr& addr,
+                                const RawAddr&,
+                                int interfaceIndex) {
   int proto = addr.addr.sa_family == AF_INET ? IPPROTO_IP : IPPROTO_IPV6;
   struct group_req mreq;
   mreq.gr_interface = interfaceIndex;
   memmove(&mreq.gr_group, &addr.ss, SocketAddress::GetAddrLength(addr));
   return NO_RETRY_EXPECTED(setsockopt(fd, proto, MCAST_LEAVE_GROUP, &mreq,
                                       sizeof(mreq))) == 0;
 }
 
 }  // namespace bin
 }  // namespace dart
 
 #endif  // defined(HOST_OS_LINUX)
 
 #endif  // !defined(DART_IO_DISABLED)