base/sync_socket_posix.cc

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "base/sync_socket.h"
   6
   7 #include <errno.h>
   8 #include <fcntl.h>
   9 #include <limits.h>
  10 #include <poll.h>
  11 #include <stddef.h>
  12 #include <stdio.h>
  13 #include <sys/ioctl.h>
  14 #include <sys/socket.h>
  15 #include <sys/types.h>
  16
  17 #if defined(OS_SOLARIS)
  18 #include <sys/filio.h>
  19 #endif
  20
  21 #include "base/check_op.h"
  22 #include "base/containers/span.h"
  23 #include "base/files/file_util.h"
  24 #include "base/threading/scoped_blocking_call.h"
  25 #include "build/build_config.h"
  26
  27 namespace base {
  28
  29 namespace {
  30 // To avoid users sending negative message lengths to Send/Receive
  31 // we clamp message lengths, which are size_t, to no more than INT_MAX.
  32 const size_t kMaxMessageLength = static_cast<size_t>(INT_MAX);
  33
  34 // Writes |length| of |buffer| into |handle|.  Returns the number of bytes
  35 // written or zero on error.  |length| must be greater than 0.
  36 size_t SendHelper(SyncSocket::Handle handle,
  37                   const void* buffer,
  38                   size_t length) {
  39   DCHECK_GT(length, 0u);
  40   DCHECK_LE(length, kMaxMessageLength);
  41   DCHECK_NE(handle, SyncSocket::kInvalidHandle);
  42   return WriteFileDescriptor(
  43              handle, make_span(static_cast<const uint8_t*>(buffer), length))
  44              ? length
  45              : 0;
  46 }
  47
  48 }  // namespace
  49
  50 // static
  51 bool SyncSocket::CreatePair(SyncSocket* socket_a, SyncSocket* socket_b) {
  52   DCHECK_NE(socket_a, socket_b);
  53   DCHECK(!socket_a->IsValid());
  54   DCHECK(!socket_b->IsValid());
  55
  56 #if defined(OS_APPLE)
  57   int nosigpipe = 1;
  58 #endif  // defined(OS_APPLE)
  59
  60   ScopedHandle handles[2];
  61
  62   {
  63     Handle raw_handles[2] = {kInvalidHandle, kInvalidHandle};
  64     if (socketpair(AF_UNIX, SOCK_STREAM, 0, raw_handles) != 0) {
  65       return false;
  66     }
  67     handles[0].reset(raw_handles[0]);
  68     handles[1].reset(raw_handles[1]);
  69   }
  70
  71 #if defined(OS_APPLE)
  72   // On OSX an attempt to read or write to a closed socket may generate a
  73   // SIGPIPE rather than returning -1.  setsockopt will shut this off.
  74   if (0 != setsockopt(handles[0].get(), SOL_SOCKET, SO_NOSIGPIPE, &nosigpipe,
  75                       sizeof(nosigpipe)) ||
  76       0 != setsockopt(handles[1].get(), SOL_SOCKET, SO_NOSIGPIPE, &nosigpipe,
  77                       sizeof(nosigpipe))) {
  78     return false;
  79   }
  80 #endif
  81
  82   // Copy the handles out for successful return.
  83   socket_a->handle_ = std::move(handles[0]);
  84   socket_b->handle_ = std::move(handles[1]);
  85
  86   return true;
  87 }
  88
  89 void SyncSocket::Close() {
  90   handle_.reset();
  91 }
  92
  93 size_t SyncSocket::Send(const void* buffer, size_t length) {
  94   ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
  95   return SendHelper(handle(), buffer, length);
  96 }
  97
  98 size_t SyncSocket::Receive(void* buffer, size_t length) {
  99   ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
 100   DCHECK_GT(length, 0u);
 101   DCHECK_LE(length, kMaxMessageLength);
 102   DCHECK(IsValid());
 103   char* charbuffer = static_cast<char*>(buffer);
 104   if (ReadFromFD(handle(), charbuffer, length))
 105     return length;
 106   return 0;
 107 }
 108
 109 size_t SyncSocket::ReceiveWithTimeout(void* buffer,
 110                                       size_t length,
 111                                       TimeDelta timeout) {
 112   ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
 113   DCHECK_GT(length, 0u);
 114   DCHECK_LE(length, kMaxMessageLength);
 115   DCHECK(IsValid());
 116
 117   // Only timeouts greater than zero and less than one second are allowed.
 118   DCHECK_GT(timeout.InMicroseconds(), 0);
 119   DCHECK_LT(timeout.InMicroseconds(),
 120             TimeDelta::FromSeconds(1).InMicroseconds());
 121
 122   // Track the start time so we can reduce the timeout as data is read.
 123   TimeTicks start_time = TimeTicks::Now();
 124   const TimeTicks finish_time = start_time + timeout;
 125
 126   struct pollfd pollfd;
 127   pollfd.fd = handle();
 128   pollfd.events = POLLIN;
 129   pollfd.revents = 0;
 130
 131   size_t bytes_read_total = 0;
 132   while (bytes_read_total < length) {
 133     const TimeDelta this_timeout = finish_time - TimeTicks::Now();
 134     const int timeout_ms =
 135         static_cast<int>(this_timeout.InMillisecondsRoundedUp());
 136     if (timeout_ms <= 0)
 137       break;
 138     const int poll_result = poll(&pollfd, 1, timeout_ms);
 139     // Handle EINTR manually since we need to update the timeout value.
 140     if (poll_result == -1 && errno == EINTR)
 141       continue;
 142     // Return if other type of error or a timeout.
 143     if (poll_result <= 0)
 144       return bytes_read_total;
 145
 146     // poll() only tells us that data is ready for reading, not how much.  We
 147     // must Peek() for the amount ready for reading to avoid blocking.
 148     // At hang up (POLLHUP), the write end has been closed and there might still
 149     // be data to be read.
 150     // No special handling is needed for error (POLLERR); we can let any of the
 151     // following operations fail and handle it there.
 152     DCHECK(pollfd.revents & (POLLIN | POLLHUP | POLLERR)) << pollfd.revents;
 153     const size_t bytes_to_read = std::min(Peek(), length - bytes_read_total);
 154
 155     // There may be zero bytes to read if the socket at the other end closed.
 156     if (!bytes_to_read)
 157       return bytes_read_total;
 158
 159     const size_t bytes_received =
 160         Receive(static_cast<char*>(buffer) + bytes_read_total, bytes_to_read);
 161     bytes_read_total += bytes_received;
 162     if (bytes_received != bytes_to_read)
 163       return bytes_read_total;
 164   }
 165
 166   return bytes_read_total;
 167 }
 168
 169 size_t SyncSocket::Peek() {
 170   DCHECK(IsValid());
 171   int number_chars = 0;
 172   if (ioctl(handle_.get(), FIONREAD, &number_chars) == -1) {
 173     // If there is an error in ioctl, signal that the channel would block.
 174     return 0;
 175   }
 176   DCHECK_GE(number_chars, 0);
 177   return number_chars;
 178 }
 179
 180 bool SyncSocket::IsValid() const {
 181   return handle_.is_valid();
 182 }
 183
 184 SyncSocket::Handle SyncSocket::handle() const {
 185   return handle_.get();
 186 }
 187
 188 SyncSocket::Handle SyncSocket::Release() {
 189   return handle_.release();
 190 }
 191
 192 bool CancelableSyncSocket::Shutdown() {
 193   DCHECK(IsValid());
 194   return HANDLE_EINTR(shutdown(handle(), SHUT_RDWR)) >= 0;
 195 }
 196
 197 size_t CancelableSyncSocket::Send(const void* buffer, size_t length) {
 198   DCHECK_GT(length, 0u);
 199   DCHECK_LE(length, kMaxMessageLength);
 200   DCHECK(IsValid());
 201
 202   const int flags = fcntl(handle(), F_GETFL);
 203   if (flags != -1 && (flags & O_NONBLOCK) == 0) {
 204     // Set the socket to non-blocking mode for sending if its original mode
 205     // is blocking.
 206     fcntl(handle(), F_SETFL, flags | O_NONBLOCK);
 207   }
 208
 209   const size_t len = SendHelper(handle(), buffer, length);
 210
 211   if (flags != -1 && (flags & O_NONBLOCK) == 0) {
 212     // Restore the original flags.
 213     fcntl(handle(), F_SETFL, flags);
 214   }
 215
 216   return len;
 217 }
 218
 219 // static
 220 bool CancelableSyncSocket::CreatePair(CancelableSyncSocket* socket_a,
 221                                       CancelableSyncSocket* socket_b) {
 222   return SyncSocket::CreatePair(socket_a, socket_b);
 223 }
 224
 225 }  // namespace base