X-Git-Url: http://plrg.eecs.uci.edu/git/?p=folly.git;a=blobdiff_plain;f=folly%2Fio%2Fasync%2FAsyncSocket.cpp;h=f32da3a75ad8e25372cd75854ba222b9c48ff9c4;hp=be71ee73309f701dfe18b11e7125388f2688a98e;hb=4c7a736d6529f22451a0ec965e093e7e318695e3;hpb=106a2a56bbf2dea08947919539944f582d283a20;ds=sidebyside diff --git a/folly/io/async/AsyncSocket.cpp b/folly/io/async/AsyncSocket.cpp index be71ee73..f32da3a7 100644 --- a/folly/io/async/AsyncSocket.cpp +++ b/folly/io/async/AsyncSocket.cpp @@ -1,5 +1,5 @@ /* - * Copyright 2016 Facebook, Inc. + * Copyright 2017 Facebook, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -17,24 +17,36 @@ #include #include +#include #include +#include #include +#include #include #include #include #include +#include #include #include -#include #include -#include +#include using std::string; using std::unique_ptr; +namespace fsp = folly::portability::sockets; + namespace folly { +static constexpr bool msgErrQueueSupported = +#ifdef MSG_ERRQUEUE + true; +#else + false; +#endif // MSG_ERRQUEUE + // static members initializers const AsyncSocket::OptionMap AsyncSocket::emptyOptionMap; @@ -90,10 +102,12 @@ class AsyncSocket::BytesWriteRequest : public AsyncSocket::WriteRequest { WriteResult performWrite() override { WriteFlags writeFlags = flags_; if (getNext() != nullptr) { - writeFlags = writeFlags | WriteFlags::CORK; + writeFlags |= WriteFlags::CORK; } - return socket_->performWrite( + auto writeResult = socket_->performWrite( getOps(), getOpCount(), writeFlags, &opsWritten_, &partialBytes_); + bytesWritten_ = writeResult.writeReturn > 0 ? writeResult.writeReturn : 0; + return writeResult; } bool isComplete() override { @@ -121,7 +135,8 @@ class AsyncSocket::BytesWriteRequest : public AsyncSocket::WriteRequest { currentOp->iov_len -= partialBytes_; // Increment the totalBytesWritten_ count by bytesWritten_; - totalBytesWritten_ += bytesWritten_; + assert(bytesWritten_ >= 0); + totalBytesWritten_ += uint32_t(bytesWritten_); } private: @@ -170,20 +185,47 @@ class AsyncSocket::BytesWriteRequest : public AsyncSocket::WriteRequest { struct iovec writeOps_[]; ///< write operation(s) list }; +int AsyncSocket::SendMsgParamsCallback::getDefaultFlags(folly::WriteFlags flags) + noexcept { + int msg_flags = MSG_DONTWAIT; + +#ifdef MSG_NOSIGNAL // Linux-only + msg_flags |= MSG_NOSIGNAL; +#ifdef MSG_MORE + if (isSet(flags, WriteFlags::CORK)) { + // MSG_MORE tells the kernel we have more data to send, so wait for us to + // give it the rest of the data rather than immediately sending a partial + // frame, even when TCP_NODELAY is enabled. + msg_flags |= MSG_MORE; + } +#endif // MSG_MORE +#endif // MSG_NOSIGNAL + if (isSet(flags, WriteFlags::EOR)) { + // marks that this is the last byte of a record (response) + msg_flags |= MSG_EOR; + } + + return msg_flags; +} + +namespace { +static AsyncSocket::SendMsgParamsCallback defaultSendMsgParamsCallback; +} + AsyncSocket::AsyncSocket() - : eventBase_(nullptr) - , writeTimeout_(this, nullptr) - , ioHandler_(this, nullptr) - , immediateReadHandler_(this) { + : eventBase_(nullptr), + writeTimeout_(this, nullptr), + ioHandler_(this, nullptr), + immediateReadHandler_(this) { VLOG(5) << "new AsyncSocket()"; init(); } AsyncSocket::AsyncSocket(EventBase* evb) - : eventBase_(evb) - , writeTimeout_(this, evb) - , ioHandler_(this, evb) - , immediateReadHandler_(this) { + : eventBase_(evb), + writeTimeout_(this, evb), + ioHandler_(this, evb), + immediateReadHandler_(this) { VLOG(5) << "new AsyncSocket(" << this << ", evb=" << evb << ")"; init(); } @@ -204,10 +246,10 @@ AsyncSocket::AsyncSocket(EventBase* evb, } AsyncSocket::AsyncSocket(EventBase* evb, int fd) - : eventBase_(evb) - , writeTimeout_(this, evb) - , ioHandler_(this, evb, fd) - , immediateReadHandler_(this) { + : eventBase_(evb), + writeTimeout_(this, evb), + ioHandler_(this, evb, fd), + immediateReadHandler_(this) { VLOG(5) << "new AsyncSocket(" << this << ", evb=" << evb << ", fd=" << fd << ")"; init(); @@ -216,10 +258,17 @@ AsyncSocket::AsyncSocket(EventBase* evb, int fd) state_ = StateEnum::ESTABLISHED; } +AsyncSocket::AsyncSocket(AsyncSocket::UniquePtr oldAsyncSocket) + : AsyncSocket(oldAsyncSocket->getEventBase(), oldAsyncSocket->detachFd()) { + preReceivedData_ = std::move(oldAsyncSocket->preReceivedData_); +} + // init() method, since constructor forwarding isn't supported in most // compilers yet. void AsyncSocket::init() { - assert(eventBase_ == nullptr || eventBase_->isInEventBaseThread()); + if (eventBase_) { + eventBase_->dcheckIsInEventBaseThread(); + } shutdownFlags_ = 0; state_ = StateEnum::UNINIT; eventFlags_ = EventHandler::NONE; @@ -227,12 +276,14 @@ void AsyncSocket::init() { sendTimeout_ = 0; maxReadsPerEvent_ = 16; connectCallback_ = nullptr; + errMessageCallback_ = nullptr; readCallback_ = nullptr; writeReqHead_ = nullptr; writeReqTail_ = nullptr; shutdownSocketSet_ = nullptr; appBytesWritten_ = 0; appBytesReceived_ = 0; + sendMsgParamCallback_ = &defaultSendMsgParamsCallback; } AsyncSocket::~AsyncSocket() { @@ -307,7 +358,7 @@ void AsyncSocket::connect(ConnectCallback* callback, const OptionMap &options, const folly::SocketAddress& bindAddr) noexcept { DestructorGuard dg(this); - assert(eventBase_->isInEventBaseThread()); + eventBase_->dcheckIsInEventBaseThread(); addr_ = address; @@ -334,7 +385,7 @@ void AsyncSocket::connect(ConnectCallback* callback, // constant (PF_xxx) rather than an address family (AF_xxx), but the // distinction is mainly just historical. In pretty much all // implementations the PF_foo and AF_foo constants are identical. - fd_ = socket(address.getFamily(), SOCK_STREAM, 0); + fd_ = fsp::socket(address.getFamily(), SOCK_STREAM, 0); if (fd_ < 0) { auto errnoCopy = errno; throw AsyncSocketException( @@ -392,7 +443,7 @@ void AsyncSocket::connect(ConnectCallback* callback, // bind the socket if (bindAddr != anyAddress()) { int one = 1; - if (::setsockopt(fd_, SOL_SOCKET, SO_REUSEADDR, &one, sizeof(one))) { + if (setsockopt(fd_, SOL_SOCKET, SO_REUSEADDR, &one, sizeof(one))) { auto errnoCopy = errno; doClose(); throw AsyncSocketException( @@ -403,7 +454,7 @@ void AsyncSocket::connect(ConnectCallback* callback, bindAddr.getAddress(&addrStorage); - if (::bind(fd_, saddr, bindAddr.getActualSize()) != 0) { + if (bind(fd_, saddr, bindAddr.getActualSize()) != 0) { auto errnoCopy = errno; doClose(); throw AsyncSocketException( @@ -415,7 +466,7 @@ void AsyncSocket::connect(ConnectCallback* callback, // Apply the additional options if any. for (const auto& opt: options) { - int rv = opt.first.apply(fd_, opt.second); + rv = opt.first.apply(fd_, opt.second); if (rv != 0) { auto errnoCopy = errno; throw AsyncSocketException( @@ -456,6 +507,7 @@ void AsyncSocket::connect(ConnectCallback* callback, // The read callback may not have been set yet, and no writes may be pending // yet, so we don't have to register for any events at the moment. VLOG(8) << "AsyncSocket::connect succeeded immediately; this=" << this; + assert(errMessageCallback_ == nullptr); assert(readCallback_ == nullptr); assert(writeReqHead_ == nullptr); if (state_ != StateEnum::FAST_OPEN) { @@ -465,11 +517,23 @@ void AsyncSocket::connect(ConnectCallback* callback, } int AsyncSocket::socketConnect(const struct sockaddr* saddr, socklen_t len) { - int rv = ::connect(fd_, saddr, len); +#if __linux__ + if (noTransparentTls_) { + // Ignore return value, errors are ok + setsockopt(fd_, SOL_SOCKET, SO_NO_TRANSPARENT_TLS, nullptr, 0); + } + if (noTSocks_) { + VLOG(4) << "Disabling TSOCKS for fd " << fd_; + // Ignore return value, errors are ok + setsockopt(fd_, SOL_SOCKET, SO_NO_TSOCKS, nullptr, 0); + } +#endif + int rv = fsp::connect(fd_, saddr, len); if (rv < 0) { auto errnoCopy = errno; if (errnoCopy == EINPROGRESS) { - scheduleConnectTimeoutAndRegisterForEvents(); + scheduleConnectTimeout(); + registerForConnectEvents(); } else { throw AsyncSocketException( AsyncSocketException::NOT_OPEN, @@ -480,18 +544,20 @@ int AsyncSocket::socketConnect(const struct sockaddr* saddr, socklen_t len) { return rv; } -void AsyncSocket::scheduleConnectTimeoutAndRegisterForEvents() { +void AsyncSocket::scheduleConnectTimeout() { // Connection in progress. - int timeout = connectTimeout_.count(); + auto timeout = connectTimeout_.count(); if (timeout > 0) { // Start a timer in case the connection takes too long. - if (!writeTimeout_.scheduleTimeout(timeout)) { + if (!writeTimeout_.scheduleTimeout(uint32_t(timeout))) { throw AsyncSocketException( AsyncSocketException::INTERNAL_ERROR, withAddr("failed to schedule AsyncSocket connect timeout")); } } +} +void AsyncSocket::registerForConnectEvents() { // Register for write events, so we'll // be notified when the connection finishes/fails. // Note that we don't register for a persistent event here. @@ -528,7 +594,9 @@ void AsyncSocket::cancelConnect() { void AsyncSocket::setSendTimeout(uint32_t milliseconds) { sendTimeout_ = milliseconds; - assert(eventBase_ == nullptr || eventBase_->isInEventBaseThread()); + if (eventBase_) { + eventBase_->dcheckIsInEventBaseThread(); + } // If we are currently pending on write requests, immediately update // writeTimeout_ with the new value. @@ -548,6 +616,68 @@ void AsyncSocket::setSendTimeout(uint32_t milliseconds) { } } +void AsyncSocket::setErrMessageCB(ErrMessageCallback* callback) { + VLOG(6) << "AsyncSocket::setErrMessageCB() this=" << this + << ", fd=" << fd_ << ", callback=" << callback + << ", state=" << state_; + + // Short circuit if callback is the same as the existing errMessageCallback_. + if (callback == errMessageCallback_) { + return; + } + + if (!msgErrQueueSupported) { + // Per-socket error message queue is not supported on this platform. + return invalidState(callback); + } + + DestructorGuard dg(this); + eventBase_->dcheckIsInEventBaseThread(); + + if (callback == nullptr) { + // We should be able to reset the callback regardless of the + // socket state. It's important to have a reliable callback + // cancellation mechanism. + errMessageCallback_ = callback; + return; + } + + switch ((StateEnum)state_) { + case StateEnum::CONNECTING: + case StateEnum::FAST_OPEN: + case StateEnum::ESTABLISHED: { + errMessageCallback_ = callback; + return; + } + case StateEnum::CLOSED: + case StateEnum::ERROR: + // We should never reach here. SHUT_READ should always be set + // if we are in STATE_CLOSED or STATE_ERROR. + assert(false); + return invalidState(callback); + case StateEnum::UNINIT: + // We do not allow setReadCallback() to be called before we start + // connecting. + return invalidState(callback); + } + + // We don't put a default case in the switch statement, so that the compiler + // will warn us to update the switch statement if a new state is added. + return invalidState(callback); +} + +AsyncSocket::ErrMessageCallback* AsyncSocket::getErrMessageCallback() const { + return errMessageCallback_; +} + +void AsyncSocket::setSendMsgParamCB(SendMsgParamsCallback* callback) { + sendMsgParamCallback_ = callback; +} + +AsyncSocket::SendMsgParamsCallback* AsyncSocket::getSendMsgParamsCB() const { + return sendMsgParamCallback_; +} + void AsyncSocket::setReadCB(ReadCallback *callback) { VLOG(6) << "AsyncSocket::setReadCallback() this=" << this << ", fd=" << fd_ << ", callback=" << callback << ", state=" << state_; @@ -588,7 +718,7 @@ void AsyncSocket::setReadCB(ReadCallback *callback) { } DestructorGuard dg(this); - assert(eventBase_->isInEventBaseThread()); + eventBase_->dcheckIsInEventBaseThread(); switch ((StateEnum)state_) { case StateEnum::CONNECTING: @@ -662,7 +792,12 @@ void AsyncSocket::writeChain(WriteCallback* callback, unique_ptr&& buf, constexpr size_t kSmallSizeMax = 64; size_t count = buf->countChainElements(); if (count <= kSmallSizeMax) { + // suppress "warning: variable length array 'vec' is used [-Wvla]" + FOLLY_PUSH_WARNING + FOLLY_GCC_DISABLE_WARNING("-Wvla") iovec vec[BOOST_PP_IF(FOLLY_HAVE_VLA, count, kSmallSizeMax)]; + FOLLY_POP_WARNING + writeChainImpl(callback, vec, count, std::move(buf), flags); } else { iovec* vec = new iovec[count]; @@ -685,7 +820,7 @@ void AsyncSocket::writeImpl(WriteCallback* callback, const iovec* vec, << ", state=" << state_; DestructorGuard dg(this); unique_ptrioBuf(std::move(buf)); - assert(eventBase_->isInEventBaseThread()); + eventBase_->dcheckIsInEventBaseThread(); if (shutdownFlags_ & (SHUT_WRITE | SHUT_WRITE_PENDING)) { // No new writes may be performed after the write side of the socket has @@ -701,7 +836,7 @@ void AsyncSocket::writeImpl(WriteCallback* callback, const iovec* vec, uint32_t countWritten = 0; uint32_t partialWritten = 0; - int bytesWritten = 0; + ssize_t bytesWritten = 0; bool mustRegister = false; if ((state_ == StateEnum::ESTABLISHED || state_ == StateEnum::FAST_OPEN) && !connecting()) { @@ -711,8 +846,8 @@ void AsyncSocket::writeImpl(WriteCallback* callback, const iovec* vec, assert(writeReqTail_ == nullptr); assert((eventFlags_ & EventHandler::WRITE) == 0); - auto writeResult = - performWrite(vec, count, flags, &countWritten, &partialWritten); + auto writeResult = performWrite( + vec, uint32_t(count), flags, &countWritten, &partialWritten); bytesWritten = writeResult.writeReturn; if (bytesWritten < 0) { auto errnoCopy = errno; @@ -752,14 +887,20 @@ void AsyncSocket::writeImpl(WriteCallback* callback, const iovec* vec, // Create a new WriteRequest to add to the queue WriteRequest* req; try { - req = BytesWriteRequest::newRequest(this, callback, vec + countWritten, - count - countWritten, partialWritten, - bytesWritten, std::move(ioBuf), flags); + req = BytesWriteRequest::newRequest( + this, + callback, + vec + countWritten, + uint32_t(count - countWritten), + partialWritten, + uint32_t(bytesWritten), + std::move(ioBuf), + flags); } catch (const std::exception& ex) { // we mainly expect to catch std::bad_alloc here AsyncSocketException tex(AsyncSocketException::INTERNAL_ERROR, withAddr(string("failed to append new WriteRequest: ") + ex.what())); - return failWrite(__func__, callback, bytesWritten, tex); + return failWrite(__func__, callback, size_t(bytesWritten), tex); } req->consume(); if (writeReqTail_ == nullptr) { @@ -829,7 +970,7 @@ void AsyncSocket::close() { // Declare a DestructorGuard to ensure that the AsyncSocket cannot be // destroyed until close() returns. DestructorGuard dg(this); - assert(eventBase_->isInEventBaseThread()); + eventBase_->dcheckIsInEventBaseThread(); // Since there are write requests pending, we have to set the // SHUT_WRITE_PENDING flag, and wait to perform the real close until the @@ -861,7 +1002,9 @@ void AsyncSocket::closeNow() { << ", state=" << state_ << ", shutdownFlags=" << std::hex << (int) shutdownFlags_; DestructorGuard dg(this); - assert(eventBase_ == nullptr || eventBase_->isInEventBaseThread()); + if (eventBase_) { + eventBase_->dcheckIsInEventBaseThread(); + } switch (state_) { case StateEnum::ESTABLISHED: @@ -953,7 +1096,7 @@ void AsyncSocket::shutdownWrite() { return; } - assert(eventBase_->isInEventBaseThread()); + eventBase_->dcheckIsInEventBaseThread(); // There are pending writes. Set SHUT_WRITE_PENDING so that the actual // shutdown will be performed once all writes complete. @@ -980,7 +1123,9 @@ void AsyncSocket::shutdownWriteNow() { } DestructorGuard dg(this); - assert(eventBase_ == nullptr || eventBase_->isInEventBaseThread()); + if (eventBase_) { + eventBase_->dcheckIsInEventBaseThread(); + } switch (static_cast(state_)) { case StateEnum::ESTABLISHED: @@ -998,7 +1143,7 @@ void AsyncSocket::shutdownWriteNow() { } // Shutdown writes on the file descriptor - ::shutdown(fd_, SHUT_WR); + shutdown(fd_, SHUT_WR); // Immediately fail all write requests failAllWrites(socketShutdownForWritesEx); @@ -1057,6 +1202,18 @@ bool AsyncSocket::readable() const { return rc == 1; } +bool AsyncSocket::writable() const { + if (fd_ == -1) { + return false; + } + struct pollfd fds[1]; + fds[0].fd = fd_; + fds[0].events = POLLOUT; + fds[0].revents = 0; + int rc = poll(fds, 1, 0); + return rc == 1; +} + bool AsyncSocket::isPending() const { return ioHandler_.isPending(); } @@ -1096,11 +1253,14 @@ void AsyncSocket::attachEventBase(EventBase* eventBase) { << ", state=" << state_ << ", events=" << std::hex << eventFlags_ << ")"; assert(eventBase_ == nullptr); - assert(eventBase->isInEventBaseThread()); + eventBase->dcheckIsInEventBaseThread(); eventBase_ = eventBase; ioHandler_.attachEventBase(eventBase); writeTimeout_.attachEventBase(eventBase); + if (evbChangeCb_) { + evbChangeCb_->evbAttached(this); + } } void AsyncSocket::detachEventBase() { @@ -1108,34 +1268,63 @@ void AsyncSocket::detachEventBase() { << ", old evb=" << eventBase_ << ", state=" << state_ << ", events=" << std::hex << eventFlags_ << ")"; assert(eventBase_ != nullptr); - assert(eventBase_->isInEventBaseThread()); + eventBase_->dcheckIsInEventBaseThread(); eventBase_ = nullptr; ioHandler_.detachEventBase(); writeTimeout_.detachEventBase(); + if (evbChangeCb_) { + evbChangeCb_->evbDetached(this); + } } bool AsyncSocket::isDetachable() const { DCHECK(eventBase_ != nullptr); - DCHECK(eventBase_->isInEventBaseThread()); + eventBase_->dcheckIsInEventBaseThread(); return !ioHandler_.isHandlerRegistered() && !writeTimeout_.isScheduled(); } -void AsyncSocket::getLocalAddress(folly::SocketAddress* address) const { +void AsyncSocket::cacheAddresses() { + if (fd_ >= 0) { + try { + cacheLocalAddress(); + cachePeerAddress(); + } catch (const std::system_error& e) { + if (e.code() != std::error_code(ENOTCONN, std::system_category())) { + VLOG(1) << "Error caching addresses: " << e.code().value() << ", " + << e.code().message(); + } + } + } +} + +void AsyncSocket::cacheLocalAddress() const { if (!localAddr_.isInitialized()) { localAddr_.setFromLocalAddress(fd_); } - *address = localAddr_; } -void AsyncSocket::getPeerAddress(folly::SocketAddress* address) const { +void AsyncSocket::cachePeerAddress() const { if (!addr_.isInitialized()) { addr_.setFromPeerAddress(fd_); } +} + +void AsyncSocket::getLocalAddress(folly::SocketAddress* address) const { + cacheLocalAddress(); + *address = localAddr_; +} + +void AsyncSocket::getPeerAddress(folly::SocketAddress* address) const { + cachePeerAddress(); *address = addr_; } +bool AsyncSocket::getTFOSucceded() const { + return detail::tfo_succeeded(fd_); +} + int AsyncSocket::setNoDelay(bool noDelay) { if (fd_ < 0) { VLOG(4) << "AsyncSocket::setNoDelay() called on non-open socket " @@ -1169,8 +1358,12 @@ int AsyncSocket::setCongestionFlavor(const std::string &cname) { } - if (setsockopt(fd_, IPPROTO_TCP, TCP_CONGESTION, cname.c_str(), - cname.length() + 1) != 0) { + if (setsockopt( + fd_, + IPPROTO_TCP, + TCP_CONGESTION, + cname.c_str(), + socklen_t(cname.length() + 1)) != 0) { int errnoCopy = errno; VLOG(2) << "failed to update TCP_CONGESTION option on AsyncSocket " << this << "(fd=" << fd_ << ", state=" << state_ << "): " @@ -1182,6 +1375,7 @@ int AsyncSocket::setCongestionFlavor(const std::string &cname) { } int AsyncSocket::setQuickAck(bool quickack) { + (void)quickack; if (fd_ < 0) { VLOG(4) << "AsyncSocket::setQuickAck() called on non-open socket " << this << "(state=" << state_ << ")"; @@ -1260,19 +1454,30 @@ int AsyncSocket::setTCPProfile(int profd) { } void AsyncSocket::ioReady(uint16_t events) noexcept { - VLOG(7) << "AsyncSocket::ioRead() this=" << this << ", fd" << fd_ + VLOG(7) << "AsyncSocket::ioRead() this=" << this << ", fd=" << fd_ << ", events=" << std::hex << events << ", state=" << state_; DestructorGuard dg(this); assert(events & EventHandler::READ_WRITE); - assert(eventBase_->isInEventBaseThread()); + eventBase_->dcheckIsInEventBaseThread(); + + uint16_t relevantEvents = uint16_t(events & EventHandler::READ_WRITE); + EventBase* originalEventBase = eventBase_; + // If we got there it means that either EventHandler::READ or + // EventHandler::WRITE is set. Any of these flags can + // indicate that there are messages available in the socket + // error message queue. + handleErrMessages(); + + // Return now if handleErrMessages() detached us from our EventBase + if (eventBase_ != originalEventBase) { + return; + } - uint16_t relevantEvents = events & EventHandler::READ_WRITE; if (relevantEvents == EventHandler::READ) { handleRead(); } else if (relevantEvents == EventHandler::WRITE) { handleWrite(); } else if (relevantEvents == EventHandler::READ_WRITE) { - EventBase* originalEventBase = eventBase_; // If both read and write events are ready, process writes first. handleWrite(); @@ -1299,12 +1504,23 @@ AsyncSocket::performRead(void** buf, size_t* buflen, size_t* /* offset */) { VLOG(5) << "AsyncSocket::performRead() this=" << this << ", buf=" << *buf << ", buflen=" << *buflen; - int recvFlags = 0; - if (peek_) { - recvFlags |= MSG_PEEK; + if (preReceivedData_ && !preReceivedData_->empty()) { + VLOG(5) << "AsyncSocket::performRead() this=" << this + << ", reading pre-received data"; + + io::Cursor cursor(preReceivedData_.get()); + auto len = cursor.pullAtMost(*buf, *buflen); + + IOBufQueue queue; + queue.append(std::move(preReceivedData_)); + queue.trimStart(len); + preReceivedData_ = queue.move(); + + appBytesReceived_ += len; + return ReadResult(len); } - ssize_t bytes = recv(fd_, *buf, *buflen, MSG_DONTWAIT | recvFlags); + ssize_t bytes = recv(fd_, *buf, *buflen, MSG_DONTWAIT); if (bytes < 0) { if (errno == EAGAIN || errno == EWOULDBLOCK) { // No more data to read right now. @@ -1318,12 +1534,69 @@ AsyncSocket::performRead(void** buf, size_t* buflen, size_t* /* offset */) { } } -void AsyncSocket::prepareReadBuffer(void** buf, size_t* buflen) noexcept { +void AsyncSocket::prepareReadBuffer(void** buf, size_t* buflen) { // no matter what, buffer should be preapared for non-ssl socket CHECK(readCallback_); readCallback_->getReadBuffer(buf, buflen); } +void AsyncSocket::handleErrMessages() noexcept { + // This method has non-empty implementation only for platforms + // supporting per-socket error queues. + VLOG(5) << "AsyncSocket::handleErrMessages() this=" << this << ", fd=" << fd_ + << ", state=" << state_; + if (errMessageCallback_ == nullptr) { + VLOG(7) << "AsyncSocket::handleErrMessages(): " + << "no callback installed - exiting."; + return; + } + +#ifdef MSG_ERRQUEUE + uint8_t ctrl[1024]; + unsigned char data; + struct msghdr msg; + iovec entry; + + entry.iov_base = &data; + entry.iov_len = sizeof(data); + msg.msg_iov = &entry; + msg.msg_iovlen = 1; + msg.msg_name = nullptr; + msg.msg_namelen = 0; + msg.msg_control = ctrl; + msg.msg_controllen = sizeof(ctrl); + msg.msg_flags = 0; + + int ret; + while (true) { + ret = recvmsg(fd_, &msg, MSG_ERRQUEUE); + VLOG(5) << "AsyncSocket::handleErrMessages(): recvmsg returned " << ret; + + if (ret < 0) { + if (errno != EAGAIN) { + auto errnoCopy = errno; + LOG(ERROR) << "::recvmsg exited with code " << ret + << ", errno: " << errnoCopy; + AsyncSocketException ex( + AsyncSocketException::INTERNAL_ERROR, + withAddr("recvmsg() failed"), + errnoCopy); + failErrMessageRead(__func__, ex); + } + return; + } + + for (struct cmsghdr* cmsg = CMSG_FIRSTHDR(&msg); + cmsg != nullptr && + cmsg->cmsg_len != 0 && + errMessageCallback_ != nullptr; + cmsg = CMSG_NXTHDR(&msg, cmsg)) { + errMessageCallback_->errMessage(*cmsg); + } + } +#endif //MSG_ERRQUEUE +} + void AsyncSocket::handleRead() noexcept { VLOG(5) << "AsyncSocket::handleRead() this=" << this << ", fd=" << fd_ << ", state=" << state_; @@ -1387,7 +1660,7 @@ void AsyncSocket::handleRead() noexcept { << bytesRead << " bytes"; if (bytesRead > 0) { if (!isBufferMovable_) { - readCallback_->readDataAvailable(bytesRead); + readCallback_->readDataAvailable(size_t(bytesRead)); } else { CHECK(kOpenSslModeMoveBufferOwnership); VLOG(5) << "this=" << this << ", AsyncSocket::handleRead() got " @@ -1541,7 +1814,7 @@ void AsyncSocket::handleWrite() noexcept { } } else { // Reads are still enabled, so we are only doing a half-shutdown - ::shutdown(fd_, SHUT_WR); + shutdown(fd_, SHUT_WR); } } } @@ -1600,6 +1873,12 @@ void AsyncSocket::checkForImmediateRead() noexcept { // be a pessimism. In most cases it probably wouldn't be readable, and we // would just waste an extra system call. Even if it is readable, waiting to // find out from libevent on the next event loop doesn't seem that bad. + // + // The exception to this is if we have pre-received data. In that case there + // is definitely data available immediately. + if (preReceivedData_ && !preReceivedData_->empty()) { + handleRead(); + } } void AsyncSocket::handleInitialReadWrite() noexcept { @@ -1607,7 +1886,6 @@ void AsyncSocket::handleInitialReadWrite() noexcept { // one here just to make sure, in case one of our calling code paths ever // changes. DestructorGuard dg(this); - // If we have a readCallback_, make sure we enable read events. We // may already be registered for reads if connectSuccess() set // the read calback. @@ -1692,7 +1970,7 @@ void AsyncSocket::handleConnect() noexcept { // are still connecting we just abort the connect rather than waiting for // it to complete. assert((shutdownFlags_ & SHUT_READ) == 0); - ::shutdown(fd_, SHUT_WR); + shutdown(fd_, SHUT_WR); shutdownFlags_ |= SHUT_WRITE; } @@ -1725,14 +2003,16 @@ void AsyncSocket::timeoutExpired() noexcept { VLOG(7) << "AsyncSocket " << this << ", fd " << fd_ << ": timeout expired: " << "state=" << state_ << ", events=" << std::hex << eventFlags_; DestructorGuard dg(this); - assert(eventBase_->isInEventBaseThread()); + eventBase_->dcheckIsInEventBaseThread(); if (state_ == StateEnum::CONNECTING) { // connect() timed out // Unregister for I/O events. if (connectCallback_) { AsyncSocketException ex( - AsyncSocketException::TIMED_OUT, "connect timed out"); + AsyncSocketException::TIMED_OUT, + folly::sformat( + "connect timed out after {}ms", connectTimeout_.count())); failConnect(__func__, ex); } else { // we faced a connect error without a connect callback, which could @@ -1743,7 +2023,9 @@ void AsyncSocket::timeoutExpired() noexcept { } } else { // a normal write operation timed out - AsyncSocketException ex(AsyncSocketException::TIMED_OUT, "write timed out"); + AsyncSocketException ex( + AsyncSocketException::TIMED_OUT, + folly::sformat("write timed out after {}ms", sendTimeout_)); failWrite(__func__, ex); } } @@ -1762,21 +2044,11 @@ AsyncSocket::sendSocketMessage(int fd, struct msghdr* msg, int msg_flags) { msg->msg_namelen = len; totalWritten = tfoSendMsg(fd_, msg, msg_flags); if (totalWritten >= 0) { - // Call tfo_succeeded to check if TFO was used. - tfoSucceeded_ = detail::tfo_succeeded(fd_); - if (errno != 0) { - auto errnoCopy = errno; - AsyncSocketException ex( - AsyncSocketException::INTERNAL_ERROR, - withAddr("error calling tfo_succeeded"), - errnoCopy); - return WriteResult( - WRITE_ERROR, folly::make_unique(ex)); - } - tfoFinished_ = true; state_ = StateEnum::ESTABLISHED; - handleInitialReadWrite(); + // We schedule this asynchrously so that we don't end up + // invoking initial read or write while a write is in progress. + scheduleInitialReadWrite(); } else if (errno == EINPROGRESS) { VLOG(4) << "TFO falling back to connecting"; // A normal sendmsg doesn't return EINPROGRESS, however @@ -1784,17 +2056,18 @@ AsyncSocket::sendSocketMessage(int fd, struct msghdr* msg, int msg_flags) { // cookie. state_ = StateEnum::CONNECTING; try { - scheduleConnectTimeoutAndRegisterForEvents(); + scheduleConnectTimeout(); + registerForConnectEvents(); } catch (const AsyncSocketException& ex) { return WriteResult( - WRITE_ERROR, folly::make_unique(ex)); + WRITE_ERROR, std::make_unique(ex)); } // Let's fake it that no bytes were written and return an errno. errno = EAGAIN; totalWritten = -1; } else if (errno == EOPNOTSUPP) { - VLOG(4) << "TFO not supported"; // Try falling back to connecting. + VLOG(4) << "TFO not supported"; state_ = StateEnum::CONNECTING; try { int ret = socketConnect((const sockaddr*)&addr, len); @@ -1802,7 +2075,7 @@ AsyncSocket::sendSocketMessage(int fd, struct msghdr* msg, int msg_flags) { // connect succeeded immediately // Treat this like no data was written. state_ = StateEnum::ESTABLISHED; - handleInitialReadWrite(); + scheduleInitialReadWrite(); } // If there was no exception during connections, // we would return that no bytes were written. @@ -1810,7 +2083,7 @@ AsyncSocket::sendSocketMessage(int fd, struct msghdr* msg, int msg_flags) { totalWritten = -1; } catch (const AsyncSocketException& ex) { return WriteResult( - WRITE_ERROR, folly::make_unique(ex)); + WRITE_ERROR, std::make_unique(ex)); } } else if (errno == EAGAIN) { // Normally sendmsg would indicate that the write would block. @@ -1819,7 +2092,7 @@ AsyncSocket::sendSocketMessage(int fd, struct msghdr* msg, int msg_flags) { // instead, and is an error condition indicating no fds available. return WriteResult( WRITE_ERROR, - folly::make_unique( + std::make_unique( AsyncSocketException::UNKNOWN, "No more free local ports")); } } else { @@ -1843,29 +2116,31 @@ AsyncSocket::WriteResult AsyncSocket::performWrite( msg.msg_namelen = 0; msg.msg_iov = const_cast(vec); msg.msg_iovlen = std::min(count, kIovMax); - msg.msg_control = nullptr; - msg.msg_controllen = 0; msg.msg_flags = 0; + msg.msg_controllen = sendMsgParamCallback_->getAncillaryDataSize(flags); + CHECK_GE(AsyncSocket::SendMsgParamsCallback::maxAncillaryDataSize, + msg.msg_controllen); - int msg_flags = MSG_DONTWAIT; - -#ifdef MSG_NOSIGNAL // Linux-only - msg_flags |= MSG_NOSIGNAL; - if (isSet(flags, WriteFlags::CORK)) { - // MSG_MORE tells the kernel we have more data to send, so wait for us to - // give it the rest of the data rather than immediately sending a partial - // frame, even when TCP_NODELAY is enabled. - msg_flags |= MSG_MORE; - } -#endif - if (isSet(flags, WriteFlags::EOR)) { - // marks that this is the last byte of a record (response) - msg_flags |= MSG_EOR; + if (msg.msg_controllen != 0) { + msg.msg_control = reinterpret_cast(alloca(msg.msg_controllen)); + sendMsgParamCallback_->getAncillaryData(flags, msg.msg_control); + } else { + msg.msg_control = nullptr; } + int msg_flags = sendMsgParamCallback_->getFlags(flags); + auto writeResult = sendSocketMessage(fd_, &msg, msg_flags); auto totalWritten = writeResult.writeReturn; if (totalWritten < 0) { - if (!writeResult.exception && errno == EAGAIN) { + bool tryAgain = (errno == EAGAIN); +#ifdef __APPLE__ + // Apple has a bug where doing a second write on a socket which we + // have opened with TFO causes an ENOTCONN to be thrown. However the + // socket is really connected, so treat ENOTCONN as a EAGAIN until + // this bug is fixed. + tryAgain |= (errno == ENOTCONN); +#endif + if (!writeResult.exception && tryAgain) { // TCP buffer is full; we can't write any more data right now. *countWritten = 0; *partialWritten = 0; @@ -1881,7 +2156,7 @@ AsyncSocket::WriteResult AsyncSocket::performWrite( uint32_t bytesWritten; uint32_t n; - for (bytesWritten = totalWritten, n = 0; n < count; ++n) { + for (bytesWritten = uint32_t(totalWritten), n = 0; n < count; ++n) { const iovec* v = vec + n; if (v->iov_len > bytesWritten) { // Partial write finished in the middle of this iovec @@ -1890,7 +2165,7 @@ AsyncSocket::WriteResult AsyncSocket::performWrite( return WriteResult(totalWritten); } - bytesWritten -= v->iov_len; + bytesWritten -= uint32_t(v->iov_len); } assert(bytesWritten == 0); @@ -1906,13 +2181,13 @@ AsyncSocket::WriteResult AsyncSocket::performWrite( * and call all currently installed callbacks. After an error, the * AsyncSocket is completely unregistered. * - * @return Returns true on succcess, or false on error. + * @return Returns true on success, or false on error. */ bool AsyncSocket::updateEventRegistration() { VLOG(5) << "AsyncSocket::updateEventRegistration(this=" << this << ", fd=" << fd_ << ", evb=" << eventBase_ << ", state=" << state_ << ", events=" << std::hex << eventFlags_; - assert(eventBase_->isInEventBaseThread()); + eventBase_->dcheckIsInEventBaseThread(); if (eventFlags_ == EventHandler::NONE) { ioHandler_.unregisterHandler(); return true; @@ -1920,7 +2195,8 @@ bool AsyncSocket::updateEventRegistration() { // Always register for persistent events, so we don't have to re-register // after being called back. - if (!ioHandler_.registerHandler(eventFlags_ | EventHandler::PERSIST)) { + if (!ioHandler_.registerHandler( + uint16_t(eventFlags_ | EventHandler::PERSIST))) { eventFlags_ = EventHandler::NONE; // we're not registered after error AsyncSocketException ex(AsyncSocketException::INTERNAL_ERROR, withAddr("failed to update AsyncSocket event registration")); @@ -1964,12 +2240,7 @@ void AsyncSocket::startFail() { } } -void AsyncSocket::finishFail() { - assert(state_ == StateEnum::ERROR); - assert(getDestructorGuardCount() > 0); - - AsyncSocketException ex(AsyncSocketException::INTERNAL_ERROR, - withAddr("socket closing after error")); +void AsyncSocket::invokeAllErrors(const AsyncSocketException& ex) { invokeConnectErr(ex); failAllWrites(ex); @@ -1980,6 +2251,22 @@ void AsyncSocket::finishFail() { } } +void AsyncSocket::finishFail() { + assert(state_ == StateEnum::ERROR); + assert(getDestructorGuardCount() > 0); + + AsyncSocketException ex( + AsyncSocketException::INTERNAL_ERROR, + withAddr("socket closing after error")); + invokeAllErrors(ex); +} + +void AsyncSocket::finishFail(const AsyncSocketException& ex) { + assert(state_ == StateEnum::ERROR); + assert(getDestructorGuardCount() > 0); + invokeAllErrors(ex); +} + void AsyncSocket::fail(const char* fn, const AsyncSocketException& ex) { VLOG(4) << "AsyncSocket(this=" << this << ", fd=" << fd_ << ", state=" << state_ << " host=" << addr_.describe() @@ -1997,7 +2284,7 @@ void AsyncSocket::failConnect(const char* fn, const AsyncSocketException& ex) { startFail(); invokeConnectErr(ex); - finishFail(); + finishFail(ex); } void AsyncSocket::failRead(const char* fn, const AsyncSocketException& ex) { @@ -2016,6 +2303,23 @@ void AsyncSocket::failRead(const char* fn, const AsyncSocketException& ex) { finishFail(); } +void AsyncSocket::failErrMessageRead(const char* fn, + const AsyncSocketException& ex) { + VLOG(5) << "AsyncSocket(this=" << this << ", fd=" << fd_ << ", state=" + << state_ << " host=" << addr_.describe() + << "): failed while reading message in " << fn << "(): " + << ex.what(); + startFail(); + + if (errMessageCallback_ != nullptr) { + ErrMessageCallback* callback = errMessageCallback_; + errMessageCallback_ = nullptr; + callback->errMessageError(ex); + } + + finishFail(); +} + void AsyncSocket::failWrite(const char* fn, const AsyncSocketException& ex) { VLOG(5) << "AsyncSocket(this=" << this << ", fd=" << fd_ << ", state=" << state_ << " host=" << addr_.describe() @@ -2075,7 +2379,7 @@ void AsyncSocket::failAllWrites(const AsyncSocketException& ex) { void AsyncSocket::invalidState(ConnectCallback* callback) { VLOG(5) << "AsyncSocket(this=" << this << ", fd=" << fd_ - << "): connect() called in invalid state " << state_; + << "): connect() called in invalid state " << state_; /* * The invalidState() methods don't use the normal failure mechanisms, @@ -2103,6 +2407,29 @@ void AsyncSocket::invalidState(ConnectCallback* callback) { } } +void AsyncSocket::invalidState(ErrMessageCallback* callback) { + VLOG(4) << "AsyncSocket(this=" << this << ", fd=" << fd_ + << "): setErrMessageCB(" << callback + << ") called in invalid state " << state_; + + AsyncSocketException ex( + AsyncSocketException::NOT_OPEN, + msgErrQueueSupported + ? "setErrMessageCB() called with socket in invalid state" + : "This platform does not support socket error message notifications"); + if (state_ == StateEnum::CLOSED || state_ == StateEnum::ERROR) { + if (callback) { + callback->errMessageError(ex); + } + } else { + startFail(); + if (callback) { + callback->errMessageError(ex); + } + finishFail(); + } +} + void AsyncSocket::invokeConnectErr(const AsyncSocketException& ex) { connectEndTime_ = std::chrono::steady_clock::now(); if (connectCallback_) {