/* * Copyright (c) Meta Platforms, Inc. and affiliates. * * This source code is licensed under the MIT license found in the * LICENSE file in the root directory of this source tree. */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace { /** * Helper function - if given error is not set, returns a generic app error. * Used by close() and closeNow(). */ constexpr auto APP_NO_ERROR = quic::GenericApplicationErrorCode::NO_ERROR; quic::QuicError maybeSetGenericAppError( folly::Optional&& error) { return std::move(error).value_or( quic::QuicError{APP_NO_ERROR, quic::toString(APP_NO_ERROR)}); } } // namespace namespace quic { QuicTransportBase::QuicTransportBase( std::shared_ptr evb, std::unique_ptr socket, bool useConnectionEndWithErrorCallback) : evb_(std::move(evb)), socket_(std::move(socket)), useConnectionEndWithErrorCallback_(useConnectionEndWithErrorCallback), lossTimeout_(this), ackTimeout_(this), pathValidationTimeout_(this), idleTimeout_(this), keepaliveTimeout_(this), drainTimeout_(this), pingTimeout_(this), excessWriteTimeout_(this), readLooper_(new FunctionLooper( evb_, [this]() { invokeReadDataAndCallbacks(); }, LooperType::ReadLooper)), peekLooper_(new FunctionLooper( evb_, [this]() { invokePeekDataAndCallbacks(); }, LooperType::PeekLooper)), writeLooper_(new FunctionLooper( evb_, [this]() { pacedWriteDataToSocket(); }, LooperType::WriteLooper)) { writeLooper_->setPacingFunction([this]() -> auto { if (isConnectionPaced(*conn_)) { return conn_->pacer->getTimeUntilNextWrite(); } return 0us; }); if (socket_) { folly::Function()> func = [&]() { return getAdditionalCmsgsForAsyncUDPSocket(); }; socket_->setAdditionalCmsgsFunc(std::move(func)); } } void QuicTransportBase::scheduleTimeout( QuicTimerCallback* callback, std::chrono::milliseconds timeout) { if (evb_) { evb_->scheduleTimeout(callback, timeout); } } void QuicTransportBase::cancelTimeout(QuicTimerCallback* callback) { callback->cancelTimerCallback(); } bool QuicTransportBase::isTimeoutScheduled(QuicTimerCallback* callback) const { return callback->isTimerCallbackScheduled(); } void QuicTransportBase::setPacingTimer( QuicTimer::SharedPtr pacingTimer) noexcept { if (pacingTimer) { writeLooper_->setPacingTimer(std::move(pacingTimer)); } } void QuicTransportBase::setCongestionControllerFactory( std::shared_ptr ccFactory) { CHECK(ccFactory); CHECK(conn_); conn_->congestionControllerFactory = ccFactory; conn_->congestionController.reset(); } std::shared_ptr QuicTransportBase::getEventBase() const { return evb_; } const std::shared_ptr QuicTransportBase::getQLogger() const { return conn_->qLogger; } void QuicTransportBase::setQLogger(std::shared_ptr qLogger) { // setQLogger can be called multiple times for the same connection and with // the same qLogger we track the number of times it gets set and the number // of times it gets reset, and only stop qlog collection when the number of // resets equals the number of times the logger was set if (!conn_->qLogger) { CHECK_EQ(qlogRefcnt_, 0); } else { CHECK_GT(qlogRefcnt_, 0); } if (qLogger) { conn_->qLogger = std::move(qLogger); conn_->qLogger->setDcid(conn_->clientChosenDestConnectionId); if (conn_->nodeType == QuicNodeType::Server) { conn_->qLogger->setScid(conn_->serverConnectionId); } else { conn_->qLogger->setScid(conn_->clientConnectionId); } qlogRefcnt_++; } else { if (conn_->qLogger) { qlogRefcnt_--; if (qlogRefcnt_ == 0) { conn_->qLogger = nullptr; } } } } folly::Optional QuicTransportBase::getClientConnectionId() const { return conn_->clientConnectionId; } folly::Optional QuicTransportBase::getServerConnectionId() const { return conn_->serverConnectionId; } folly::Optional QuicTransportBase::getClientChosenDestConnectionId() const { return conn_->clientChosenDestConnectionId; } const folly::SocketAddress& QuicTransportBase::getPeerAddress() const { return conn_->peerAddress; } const folly::SocketAddress& QuicTransportBase::getOriginalPeerAddress() const { return conn_->originalPeerAddress; } const folly::SocketAddress& QuicTransportBase::getLocalAddress() const { return socket_ && socket_->isBound() ? socket_->address() : localFallbackAddress; } QuicTransportBase::~QuicTransportBase() { resetConnectionCallbacks(); // Just in case this ended up hanging around. cancelTimeout(&drainTimeout_); // closeImpl and closeUdpSocket should have been triggered by destructor of // derived class to ensure that observers are properly notified DCHECK_NE(CloseState::OPEN, closeState_); DCHECK(!socket_.get()); // should be no socket } bool QuicTransportBase::good() const { return closeState_ == CloseState::OPEN && hasWriteCipher() && !error(); } bool QuicTransportBase::replaySafe() const { return (conn_->oneRttWriteCipher != nullptr); } bool QuicTransportBase::error() const { return conn_->localConnectionError.has_value(); } void QuicTransportBase::close(folly::Optional errorCode) { [[maybe_unused]] auto self = sharedGuard(); // The caller probably doesn't need a conn callback any more because they // explicitly called close. resetConnectionCallbacks(); // If we were called with no error code, ensure that we are going to write // an application close, so the peer knows it didn't come from the transport. errorCode = maybeSetGenericAppError(std::move(errorCode)); closeImpl(std::move(errorCode), true); } void QuicTransportBase::closeNow(folly::Optional errorCode) { DCHECK(getEventBase() && getEventBase()->isInEventBaseThread()); [[maybe_unused]] auto self = sharedGuard(); VLOG(4) << __func__ << " " << *this; errorCode = maybeSetGenericAppError(std::move(errorCode)); closeImpl(std::move(errorCode), false); // the drain timeout may have been scheduled by a previous close, in which // case, our close would not take effect. This cancels the drain timeout in // this case and expires the timeout. if (isTimeoutScheduled(&drainTimeout_)) { cancelTimeout(&drainTimeout_); drainTimeoutExpired(); } } void QuicTransportBase::closeGracefully() { if (closeState_ == CloseState::CLOSED || closeState_ == CloseState::GRACEFUL_CLOSING) { return; } [[maybe_unused]] auto self = sharedGuard(); resetConnectionCallbacks(); closeState_ = CloseState::GRACEFUL_CLOSING; updatePacingOnClose(*conn_); if (conn_->qLogger) { conn_->qLogger->addConnectionClose(kNoError, kGracefulExit, true, false); } // Stop reads and cancel all the app callbacks. VLOG(10) << "Stopping read and peek loopers due to graceful close " << *this; readLooper_->stop(); peekLooper_->stop(); cancelAllAppCallbacks( QuicError(QuicErrorCode(LocalErrorCode::NO_ERROR), "Graceful Close")); // All streams are closed, close the transport for realz. if (conn_->streamManager->streamCount() == 0) { closeImpl(folly::none); } } // TODO: t64691045 change the closeImpl API to include both the sanitized and // unsanited error message, remove exceptionCloseWhat_. void QuicTransportBase::closeImpl( folly::Optional errorCode, bool drainConnection, bool sendCloseImmediately) { if (closeState_ == CloseState::CLOSED) { return; } if (getSocketObserverContainer()) { SocketObserverInterface::CloseStartedEvent event; event.maybeCloseReason = errorCode; getSocketObserverContainer()->invokeInterfaceMethodAllObservers( [&event](auto observer, auto observed) { observer->closeStarted(observed, event); }); } drainConnection = drainConnection & conn_->transportSettings.shouldDrain; uint64_t totalCryptoDataWritten = 0; uint64_t totalCryptoDataRecvd = 0; if (conn_->cryptoState) { totalCryptoDataWritten += conn_->cryptoState->initialStream.currentWriteOffset; totalCryptoDataWritten += conn_->cryptoState->handshakeStream.currentWriteOffset; totalCryptoDataWritten += conn_->cryptoState->oneRttStream.currentWriteOffset; totalCryptoDataRecvd += conn_->cryptoState->initialStream.maxOffsetObserved; totalCryptoDataRecvd += conn_->cryptoState->handshakeStream.maxOffsetObserved; totalCryptoDataRecvd += conn_->cryptoState->oneRttStream.maxOffsetObserved; } if (conn_->qLogger) { conn_->qLogger->addTransportSummary( {conn_->lossState.totalBytesSent, conn_->lossState.totalBytesRecvd, conn_->flowControlState.sumCurWriteOffset, conn_->flowControlState.sumMaxObservedOffset, conn_->flowControlState.sumCurStreamBufferLen, conn_->lossState.totalBytesRetransmitted, conn_->lossState.totalStreamBytesCloned, conn_->lossState.totalBytesCloned, totalCryptoDataWritten, totalCryptoDataRecvd, conn_->congestionController ? conn_->congestionController->getWritableBytes() : std::numeric_limits::max(), getSendConnFlowControlBytesWire(*conn_), conn_->lossState.totalPacketsSpuriouslyMarkedLost, conn_->lossState.reorderingThreshold, uint64_t(conn_->transportSettings.timeReorderingThreshDividend), conn_->usedZeroRtt, conn_->version.value_or(QuicVersion::MVFST_INVALID), conn_->dsrPacketCount}); } // TODO: truncate the error code string to be 1MSS only. closeState_ = CloseState::CLOSED; updatePacingOnClose(*conn_); auto cancelCode = QuicError( QuicErrorCode(LocalErrorCode::NO_ERROR), toString(LocalErrorCode::NO_ERROR).str()); if (conn_->peerConnectionError) { cancelCode = *conn_->peerConnectionError; } else if (errorCode) { cancelCode = *errorCode; } // cancelCode is used for communicating error message to local app layer. // errorCode will be used for localConnectionError, and sent in close frames. // It's safe to include the unsanitized error message in cancelCode if (exceptionCloseWhat_) { cancelCode.message = exceptionCloseWhat_.value(); } bool isReset = false; bool isAbandon = false; bool isInvalidMigration = false; LocalErrorCode* localError = cancelCode.code.asLocalErrorCode(); TransportErrorCode* transportError = cancelCode.code.asTransportErrorCode(); if (localError) { isReset = *localError == LocalErrorCode::CONNECTION_RESET; isAbandon = *localError == LocalErrorCode::CONNECTION_ABANDONED; } isInvalidMigration = transportError && *transportError == TransportErrorCode::INVALID_MIGRATION; VLOG_IF(4, isReset) << "Closing transport due to stateless reset " << *this; VLOG_IF(4, isAbandon) << "Closing transport due to abandoned connection " << *this; if (errorCode) { conn_->localConnectionError = errorCode; std::string errorStr = conn_->localConnectionError->message; std::string errorCodeStr = errorCode->message; if (conn_->qLogger) { conn_->qLogger->addConnectionClose( errorStr, errorCodeStr, drainConnection, sendCloseImmediately); } } else { auto reason = folly::to( "Server: ", kNoError, ", Peer: isReset: ", isReset, ", Peer: isAbandon: ", isAbandon); if (conn_->qLogger) { conn_->qLogger->addConnectionClose( kNoError, reason, drainConnection, sendCloseImmediately); } } cancelLossTimeout(); cancelTimeout(&ackTimeout_); cancelTimeout(&pathValidationTimeout_); cancelTimeout(&idleTimeout_); cancelTimeout(&keepaliveTimeout_); cancelTimeout(&pingTimeout_); cancelTimeout(&excessWriteTimeout_); VLOG(10) << "Stopping read looper due to immediate close " << *this; readLooper_->stop(); peekLooper_->stop(); writeLooper_->stop(); cancelAllAppCallbacks(cancelCode); // Clear out all the pending events, we don't need them any more. closeTransport(); // Clear out all the streams, we don't need them any more. When the peer // receives the conn close they will implicitly reset all the streams. conn_->streamManager->clearOpenStreams(); // Clear out all the buffered datagrams conn_->datagramState.readBuffer.clear(); conn_->datagramState.writeBuffer.clear(); // Clear out all the pending events. conn_->pendingEvents = QuicConnectionStateBase::PendingEvents(); conn_->streamManager->clearActionable(); conn_->streamManager->clearWritable(); if (conn_->ackStates.initialAckState) { conn_->ackStates.initialAckState->acks.clear(); } if (conn_->ackStates.handshakeAckState) { conn_->ackStates.handshakeAckState->acks.clear(); } conn_->ackStates.appDataAckState.acks.clear(); if (transportReadyNotified_) { // This connection was open, update the stats for close. QUIC_STATS(conn_->statsCallback, onConnectionClose, cancelCode.code); processConnectionCallbacks(cancelCode); } else { processConnectionSetupCallbacks(cancelCode); } // can't invoke connection callbacks any more. resetConnectionCallbacks(); // Don't need outstanding packets. conn_->outstandings.reset(); // We don't need no congestion control. conn_->congestionController = nullptr; sendCloseImmediately = sendCloseImmediately && !isReset && !isAbandon; if (sendCloseImmediately) { // We might be invoked from the destructor, so just send the connection // close directly. try { writeData(); } catch (const std::exception& ex) { // This could happen if the writes fail. LOG(ERROR) << "close threw exception " << ex.what() << " " << *this; } } drainConnection = drainConnection && !isReset && !isAbandon && !isInvalidMigration; if (drainConnection) { // We ever drain once, and the object ever gets created once. DCHECK(!isTimeoutScheduled(&drainTimeout_)); scheduleTimeout( &drainTimeout_, folly::chrono::ceil( kDrainFactor * calculatePTO(*conn_))); } else { drainTimeoutExpired(); } } void QuicTransportBase::closeUdpSocket() { if (!socket_) { return; } if (getSocketObserverContainer()) { SocketObserverInterface::ClosingEvent event; // empty for now getSocketObserverContainer()->invokeInterfaceMethodAllObservers( [&event](auto observer, auto observed) { observer->closing(observed, event); }); } auto sock = std::move(socket_); socket_ = nullptr; sock->pauseRead(); sock->close(); } bool QuicTransportBase::processCancelCode(const QuicError& cancelCode) { bool noError = false; switch (cancelCode.code.type()) { case QuicErrorCode::Type::LocalErrorCode: { LocalErrorCode localErrorCode = *cancelCode.code.asLocalErrorCode(); noError = localErrorCode == LocalErrorCode::NO_ERROR || localErrorCode == LocalErrorCode::IDLE_TIMEOUT || localErrorCode == LocalErrorCode::SHUTTING_DOWN; break; } case QuicErrorCode::Type::TransportErrorCode: { TransportErrorCode transportErrorCode = *cancelCode.code.asTransportErrorCode(); noError = transportErrorCode == TransportErrorCode::NO_ERROR; break; } case QuicErrorCode::Type::ApplicationErrorCode: auto appErrorCode = *cancelCode.code.asApplicationErrorCode(); noError = appErrorCode == APP_NO_ERROR; } return noError; } void QuicTransportBase::processConnectionSetupCallbacks( const QuicError& cancelCode) { // connSetupCallback_ could be null if start() was never // invoked and the transport was destroyed or if the app initiated close. if (connSetupCallback_) { connSetupCallback_->onConnectionSetupError( QuicError(cancelCode.code, cancelCode.message)); } } void QuicTransportBase::processConnectionCallbacks( const QuicError& cancelCode) { // connCallback_ could be null if start() was never // invoked and the transport was destroyed or if the app initiated close. if (!connCallback_) { return; } if (useConnectionEndWithErrorCallback_) { connCallback_->onConnectionEnd(cancelCode); return; } if (bool noError = processCancelCode(cancelCode)) { connCallback_->onConnectionEnd(); } else { connCallback_->onConnectionError(cancelCode); } } void QuicTransportBase::drainTimeoutExpired() noexcept { closeUdpSocket(); unbindConnection(); } folly::Expected QuicTransportBase::getStreamReadOffset( StreamId) const { return 0; } folly::Expected QuicTransportBase::getStreamWriteOffset( StreamId id) const { if (isReceivingStream(conn_->nodeType, id)) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } try { auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(id)); return stream->currentWriteOffset; } catch (const QuicInternalException& ex) { VLOG(4) << __func__ << " " << ex.what() << " " << *this; return folly::makeUnexpected(ex.errorCode()); } catch (const QuicTransportException& ex) { VLOG(4) << __func__ << " " << ex.what() << " " << *this; return folly::makeUnexpected(LocalErrorCode::TRANSPORT_ERROR); } catch (const std::exception& ex) { VLOG(4) << __func__ << " " << ex.what() << " " << *this; return folly::makeUnexpected(LocalErrorCode::INTERNAL_ERROR); } } folly::Expected QuicTransportBase::getStreamWriteBufferedBytes(StreamId id) const { if (isReceivingStream(conn_->nodeType, id)) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } try { auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(id)); return stream->writeBuffer.chainLength(); } catch (const QuicInternalException& ex) { VLOG(4) << __func__ << " " << ex.what() << " " << *this; return folly::makeUnexpected(ex.errorCode()); } catch (const QuicTransportException& ex) { VLOG(4) << __func__ << " " << ex.what() << " " << *this; return folly::makeUnexpected(LocalErrorCode::TRANSPORT_ERROR); } catch (const std::exception& ex) { VLOG(4) << __func__ << " " << ex.what() << " " << *this; return folly::makeUnexpected(LocalErrorCode::INTERNAL_ERROR); } } /** * Getters for details from the transport/security layers such as * RTT, rxmit, cwnd, mss, app protocol, handshake latency, * client proposed ciphers, etc. */ QuicSocket::TransportInfo QuicTransportBase::getTransportInfo() const { CongestionControlType congestionControlType = CongestionControlType::None; uint64_t writableBytes = std::numeric_limits::max(); uint64_t congestionWindow = std::numeric_limits::max(); folly::Optional maybeCCState; uint64_t burstSize = 0; std::chrono::microseconds pacingInterval = 0ms; if (conn_->congestionController) { congestionControlType = conn_->congestionController->type(); writableBytes = conn_->congestionController->getWritableBytes(); congestionWindow = conn_->congestionController->getCongestionWindow(); maybeCCState = conn_->congestionController->getState(); if (isConnectionPaced(*conn_)) { burstSize = conn_->pacer->getCachedWriteBatchSize(); pacingInterval = conn_->pacer->getTimeUntilNextWrite(); } } TransportInfo transportInfo; transportInfo.connectionTime = conn_->connectionTime; transportInfo.srtt = conn_->lossState.srtt; transportInfo.rttvar = conn_->lossState.rttvar; transportInfo.lrtt = conn_->lossState.lrtt; transportInfo.maybeLrtt = conn_->lossState.maybeLrtt; transportInfo.maybeLrttAckDelay = conn_->lossState.maybeLrttAckDelay; if (conn_->lossState.mrtt != kDefaultMinRtt) { transportInfo.maybeMinRtt = conn_->lossState.mrtt; } transportInfo.maybeMinRttNoAckDelay = conn_->lossState.maybeMrttNoAckDelay; transportInfo.mss = conn_->udpSendPacketLen; transportInfo.congestionControlType = congestionControlType; transportInfo.writableBytes = writableBytes; transportInfo.congestionWindow = congestionWindow; transportInfo.pacingBurstSize = burstSize; transportInfo.pacingInterval = pacingInterval; transportInfo.packetsRetransmitted = conn_->lossState.rtxCount; transportInfo.totalPacketsSent = conn_->lossState.totalPacketsSent; transportInfo.totalAckElicitingPacketsSent = conn_->lossState.totalAckElicitingPacketsSent; transportInfo.totalPacketsMarkedLost = conn_->lossState.totalPacketsMarkedLost; transportInfo.totalPacketsMarkedLostByTimeout = conn_->lossState.totalPacketsMarkedLostByTimeout; transportInfo.totalPacketsMarkedLostByReorderingThreshold = conn_->lossState.totalPacketsMarkedLostByReorderingThreshold; transportInfo.totalPacketsSpuriouslyMarkedLost = conn_->lossState.totalPacketsSpuriouslyMarkedLost; transportInfo.timeoutBasedLoss = conn_->lossState.timeoutBasedRtxCount; transportInfo.totalBytesRetransmitted = conn_->lossState.totalBytesRetransmitted; transportInfo.pto = calculatePTO(*conn_); transportInfo.bytesSent = conn_->lossState.totalBytesSent; transportInfo.bytesAcked = conn_->lossState.totalBytesAcked; transportInfo.bytesRecvd = conn_->lossState.totalBytesRecvd; transportInfo.bytesInFlight = conn_->lossState.inflightBytes; transportInfo.bodyBytesSent = conn_->lossState.totalBodyBytesSent; transportInfo.bodyBytesAcked = conn_->lossState.totalBodyBytesAcked; transportInfo.totalStreamBytesSent = conn_->lossState.totalStreamBytesSent; transportInfo.totalNewStreamBytesSent = conn_->lossState.totalNewStreamBytesSent; transportInfo.ptoCount = conn_->lossState.ptoCount; transportInfo.totalPTOCount = conn_->lossState.totalPTOCount; transportInfo.largestPacketAckedByPeer = conn_->ackStates.appDataAckState.largestAckedByPeer; transportInfo.largestPacketSent = conn_->lossState.largestSent; transportInfo.usedZeroRtt = conn_->usedZeroRtt; transportInfo.maybeCCState = maybeCCState; return transportInfo; } folly::Optional QuicTransportBase::getAppProtocol() const { return conn_->handshakeLayer->getApplicationProtocol(); } uint64_t QuicTransportBase::getConnectionBufferAvailable() const { return bufferSpaceAvailable(); } uint64_t QuicTransportBase::bufferSpaceAvailable() const { auto bytesBuffered = conn_->flowControlState.sumCurStreamBufferLen; auto totalBufferSpaceAvailable = conn_->transportSettings.totalBufferSpaceAvailable; return bytesBuffered > totalBufferSpaceAvailable ? 0 : totalBufferSpaceAvailable - bytesBuffered; } folly::Expected QuicTransportBase::getConnectionFlowControl() const { return QuicSocket::FlowControlState( getSendConnFlowControlBytesAPI(*conn_), conn_->flowControlState.peerAdvertisedMaxOffset, getRecvConnFlowControlBytes(*conn_), conn_->flowControlState.advertisedMaxOffset); } folly::Expected QuicTransportBase::getStreamFlowControl(StreamId id) const { if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(id)); return QuicSocket::FlowControlState( getSendStreamFlowControlBytesAPI(*stream), stream->flowControlState.peerAdvertisedMaxOffset, getRecvStreamFlowControlBytes(*stream), stream->flowControlState.advertisedMaxOffset); } folly::Expected QuicTransportBase::getMaxWritableOnStream(StreamId id) const { if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } if (isReceivingStream(conn_->nodeType, id)) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(id)); return maxWritableOnStream(*stream); } folly::Expected QuicTransportBase::setConnectionFlowControlWindow(uint64_t windowSize) { if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } conn_->flowControlState.windowSize = windowSize; maybeSendConnWindowUpdate(*conn_, Clock::now()); updateWriteLooper(true); return folly::unit; } folly::Expected QuicTransportBase::setStreamFlowControlWindow( StreamId id, uint64_t windowSize) { if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(id)); stream->flowControlState.windowSize = windowSize; maybeSendStreamWindowUpdate(*stream, Clock::now()); updateWriteLooper(true); return folly::unit; } folly::Expected QuicTransportBase::setReadCallback( StreamId id, ReadCallback* cb, folly::Optional err) { if (isSendingStream(conn_->nodeType, id)) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } return setReadCallbackInternal(id, cb, err); } void QuicTransportBase::unsetAllReadCallbacks() { for (const auto& [id, _] : readCallbacks_) { setReadCallbackInternal(id, nullptr, APP_NO_ERROR); } } void QuicTransportBase::unsetAllPeekCallbacks() { for (const auto& [id, _] : peekCallbacks_) { setPeekCallbackInternal(id, nullptr); } } void QuicTransportBase::unsetAllDeliveryCallbacks() { auto deliveryCallbacksCopy = deliveryCallbacks_; for (const auto& [id, _] : deliveryCallbacksCopy) { cancelDeliveryCallbacksForStream(id); } } folly::Expected QuicTransportBase::setReadCallbackInternal( StreamId id, ReadCallback* cb, folly::Optional err) noexcept { VLOG(4) << "Setting setReadCallback for stream=" << id << " cb=" << cb << " " << *this; auto readCbIt = readCallbacks_.find(id); if (readCbIt == readCallbacks_.end()) { // Don't allow initial setting of a nullptr callback. if (!cb) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } readCbIt = readCallbacks_.emplace(id, ReadCallbackData(cb)).first; } auto& readCb = readCbIt->second.readCb; if (readCb == nullptr && cb != nullptr) { // It's already been set to nullptr we do not allow unsetting it. return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } else { readCb = cb; if (readCb == nullptr && err) { return stopSending(id, err.value()); } } updateReadLooper(); return folly::unit; } folly::Expected QuicTransportBase::pauseRead( StreamId id) { VLOG(4) << __func__ << " " << *this << " stream=" << id; return pauseOrResumeRead(id, false); } folly::Expected QuicTransportBase::stopSending( StreamId id, ApplicationErrorCode error) { if (isSendingStream(conn_->nodeType, id)) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } auto* stream = CHECK_NOTNULL(conn_->streamManager->getStream(id)); if (stream->recvState == StreamRecvState::Closed) { // skip STOP_SENDING if ingress is already closed return folly::unit; } if (conn_->transportSettings.dropIngressOnStopSending) { processTxStopSending(*stream); } // send STOP_SENDING frame to peer sendSimpleFrame(*conn_, StopSendingFrame(id, error)); updateWriteLooper(true); return folly::unit; } folly::Expected QuicTransportBase::resumeRead( StreamId id) { VLOG(4) << __func__ << " " << *this << " stream=" << id; return pauseOrResumeRead(id, true); } folly::Expected QuicTransportBase::pauseOrResumeRead(StreamId id, bool resume) { if (isSendingStream(conn_->nodeType, id)) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } auto readCb = readCallbacks_.find(id); if (readCb == readCallbacks_.end()) { return folly::makeUnexpected(LocalErrorCode::APP_ERROR); } if (readCb->second.resumed != resume) { readCb->second.resumed = resume; updateReadLooper(); } return folly::unit; } void QuicTransportBase::invokeReadDataAndCallbacks() { auto self = sharedGuard(); SCOPE_EXIT { self->checkForClosedStream(); self->updateReadLooper(); self->updateWriteLooper(true); }; // Need a copy since the set can change during callbacks. std::vector readableStreamsCopy; const auto& readableStreams = self->conn_->streamManager->readableStreams(); readableStreamsCopy.reserve(readableStreams.size()); std::copy( readableStreams.begin(), readableStreams.end(), std::back_inserter(readableStreamsCopy)); if (self->conn_->transportSettings.orderedReadCallbacks) { std::sort(readableStreamsCopy.begin(), readableStreamsCopy.end()); } for (StreamId streamId : readableStreamsCopy) { auto callback = self->readCallbacks_.find(streamId); if (callback == self->readCallbacks_.end()) { // Stream doesn't have a read callback set, skip it. continue; } auto readCb = callback->second.readCb; auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(streamId)); if (readCb && stream->streamReadError) { self->conn_->streamManager->readableStreams().erase(streamId); readCallbacks_.erase(callback); // if there is an error on the stream - it's not readable anymore, so // we cannot peek into it as well. self->conn_->streamManager->peekableStreams().erase(streamId); peekCallbacks_.erase(streamId); VLOG(10) << "invoking read error callbacks on stream=" << streamId << " " << *this; if (!stream->groupId) { readCb->readError(streamId, QuicError(*stream->streamReadError)); } else { readCb->readErrorWithGroup( streamId, *stream->groupId, QuicError(*stream->streamReadError)); } } else if ( readCb && callback->second.resumed && stream->hasReadableData()) { VLOG(10) << "invoking read callbacks on stream=" << streamId << " " << *this; if (!stream->groupId) { readCb->readAvailable(streamId); } else { readCb->readAvailableWithGroup(streamId, *stream->groupId); } } } if (self->datagramCallback_ && !conn_->datagramState.readBuffer.empty()) { self->datagramCallback_->onDatagramsAvailable(); } } void QuicTransportBase::updateReadLooper() { if (closeState_ != CloseState::OPEN) { VLOG(10) << "Stopping read looper " << *this; readLooper_->stop(); return; } auto iter = std::find_if( conn_->streamManager->readableStreams().begin(), conn_->streamManager->readableStreams().end(), [&readCallbacks = readCallbacks_](StreamId s) { auto readCb = readCallbacks.find(s); if (readCb == readCallbacks.end()) { return false; } // TODO: if the stream has an error and it is also paused we should // still return an error return readCb->second.readCb && readCb->second.resumed; }); if (iter != conn_->streamManager->readableStreams().end() || !conn_->datagramState.readBuffer.empty()) { VLOG(10) << "Scheduling read looper " << *this; readLooper_->run(); } else { VLOG(10) << "Stopping read looper " << *this; readLooper_->stop(); } } folly::Expected QuicTransportBase::setPeekCallback( StreamId id, PeekCallback* cb) { if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } setPeekCallbackInternal(id, cb); return folly::unit; } folly::Expected QuicTransportBase::setPeekCallbackInternal( StreamId id, PeekCallback* cb) noexcept { VLOG(4) << "Setting setPeekCallback for stream=" << id << " cb=" << cb << " " << *this; auto peekCbIt = peekCallbacks_.find(id); if (peekCbIt == peekCallbacks_.end()) { // Don't allow initial setting of a nullptr callback. if (!cb) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } peekCbIt = peekCallbacks_.emplace(id, PeekCallbackData(cb)).first; } if (!cb) { VLOG(10) << "Resetting the peek callback to nullptr " << "stream=" << id << " peekCb=" << peekCbIt->second.peekCb; } peekCbIt->second.peekCb = cb; updatePeekLooper(); return folly::unit; } folly::Expected QuicTransportBase::pausePeek( StreamId id) { VLOG(4) << __func__ << " " << *this << " stream=" << id; return pauseOrResumePeek(id, false); } folly::Expected QuicTransportBase::resumePeek( StreamId id) { VLOG(4) << __func__ << " " << *this << " stream=" << id; return pauseOrResumePeek(id, true); } folly::Expected QuicTransportBase::pauseOrResumePeek(StreamId id, bool resume) { if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } auto peekCb = peekCallbacks_.find(id); if (peekCb == peekCallbacks_.end()) { return folly::makeUnexpected(LocalErrorCode::APP_ERROR); } if (peekCb->second.resumed != resume) { peekCb->second.resumed = resume; updatePeekLooper(); } return folly::unit; } void QuicTransportBase::invokePeekDataAndCallbacks() { auto self = sharedGuard(); SCOPE_EXIT { self->checkForClosedStream(); self->updatePeekLooper(); self->updateWriteLooper(true); }; // TODO: add protection from calling "consume" in the middle of the peek - // one way is to have a peek counter that is incremented when peek calblack // is called and decremented when peek is done. once counter transitions // to 0 we can execute "consume" calls that were done during "peek", for that, // we would need to keep stack of them. std::vector peekableStreamsCopy; const auto& peekableStreams = self->conn_->streamManager->peekableStreams(); peekableStreamsCopy.reserve(peekableStreams.size()); std::copy( peekableStreams.begin(), peekableStreams.end(), std::back_inserter(peekableStreamsCopy)); VLOG(10) << __func__ << " peekableListCopy.size()=" << peekableStreamsCopy.size(); for (StreamId streamId : peekableStreamsCopy) { auto callback = self->peekCallbacks_.find(streamId); // This is a likely bug. Need to think more on whether events can // be dropped // remove streamId from list of peekable - as opposed to "read", "peek" is // only called once per streamId and not on every EVB loop until application // reads the data. self->conn_->streamManager->peekableStreams().erase(streamId); if (callback == self->peekCallbacks_.end()) { VLOG(10) << " No peek callback for stream=" << streamId; continue; } auto peekCb = callback->second.peekCb; auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(streamId)); if (peekCb && stream->streamReadError) { VLOG(10) << "invoking peek error callbacks on stream=" << streamId << " " << *this; peekCb->peekError(streamId, QuicError(*stream->streamReadError)); } else if ( peekCb && !stream->streamReadError && stream->hasPeekableData()) { VLOG(10) << "invoking peek callbacks on stream=" << streamId << " " << *this; peekDataFromQuicStream( *stream, [&](StreamId id, const folly::Range& peekRange) { peekCb->onDataAvailable(id, peekRange); }); } else { VLOG(10) << "Not invoking peek callbacks on stream=" << streamId; } } } void QuicTransportBase::invokeStreamsAvailableCallbacks() { if (conn_->streamManager->consumeMaxLocalBidirectionalStreamIdIncreased()) { // check in case new streams were created in preceding callbacks // and max is already reached if (auto numStreams = getNumOpenableBidirectionalStreams() > 0) { connCallback_->onBidirectionalStreamsAvailable(numStreams); } } if (conn_->streamManager->consumeMaxLocalUnidirectionalStreamIdIncreased()) { // check in case new streams were created in preceding callbacks // and max is already reached if (auto numStreams = getNumOpenableUnidirectionalStreams() > 0) { connCallback_->onUnidirectionalStreamsAvailable(numStreams); } } } void QuicTransportBase::updatePeekLooper() { if (peekCallbacks_.empty() || closeState_ != CloseState::OPEN) { VLOG(10) << "Stopping peek looper " << *this; peekLooper_->stop(); return; } VLOG(10) << "Updating peek looper, has " << conn_->streamManager->peekableStreams().size() << " peekable streams"; auto iter = std::find_if( conn_->streamManager->peekableStreams().begin(), conn_->streamManager->peekableStreams().end(), [&peekCallbacks = peekCallbacks_](StreamId s) { VLOG(10) << "Checking stream=" << s; auto peekCb = peekCallbacks.find(s); if (peekCb == peekCallbacks.end()) { VLOG(10) << "No peek callbacks for stream=" << s; return false; } if (!peekCb->second.resumed) { VLOG(10) << "peek callback for stream=" << s << " not resumed"; } if (!peekCb->second.peekCb) { VLOG(10) << "no peekCb in peekCb stream=" << s; } return peekCb->second.peekCb && peekCb->second.resumed; }); if (iter != conn_->streamManager->peekableStreams().end()) { VLOG(10) << "Scheduling peek looper " << *this; peekLooper_->run(); } else { VLOG(10) << "Stopping peek looper " << *this; peekLooper_->stop(); } } void QuicTransportBase::updateWriteLooper(bool thisIteration) { if (closeState_ == CloseState::CLOSED) { VLOG(10) << nodeToString(conn_->nodeType) << " stopping write looper because conn closed " << *this; writeLooper_->stop(); return; } // TODO: Also listens to write event from libevent. Only schedule write when // the socket itself is writable. auto writeDataReason = shouldWriteData(*conn_); if (writeDataReason != WriteDataReason::NO_WRITE) { VLOG(10) << nodeToString(conn_->nodeType) << " running write looper thisIteration=" << thisIteration << " " << *this; writeLooper_->run(thisIteration); if (conn_->loopDetectorCallback) { conn_->writeDebugState.needsWriteLoopDetect = (conn_->loopDetectorCallback != nullptr); } } else { VLOG(10) << nodeToString(conn_->nodeType) << " stopping write looper " << *this; writeLooper_->stop(); if (conn_->loopDetectorCallback) { conn_->writeDebugState.needsWriteLoopDetect = false; conn_->writeDebugState.currentEmptyLoopCount = 0; } } if (conn_->loopDetectorCallback) { conn_->writeDebugState.writeDataReason = writeDataReason; } } void QuicTransportBase::cancelDeliveryCallbacksForStream(StreamId id) { cancelByteEventCallbacksForStream(ByteEvent::Type::ACK, id); } void QuicTransportBase::cancelDeliveryCallbacksForStream( StreamId id, uint64_t offset) { cancelByteEventCallbacksForStream(ByteEvent::Type::ACK, id, offset); } void QuicTransportBase::cancelByteEventCallbacksForStream( const StreamId id, const folly::Optional& offset) { invokeForEachByteEventType(([this, id, &offset](const ByteEvent::Type type) { cancelByteEventCallbacksForStream(type, id, offset); })); } void QuicTransportBase::cancelByteEventCallbacksForStream( const ByteEvent::Type type, const StreamId id, const folly::Optional& offset) { if (isReceivingStream(conn_->nodeType, id)) { return; } auto& byteEventMap = getByteEventMap(type); auto byteEventMapIt = byteEventMap.find(id); if (byteEventMapIt == byteEventMap.end()) { switch (type) { case ByteEvent::Type::ACK: conn_->streamManager->removeDeliverable(id); break; case ByteEvent::Type::TX: conn_->streamManager->removeTx(id); break; } return; } auto& streamByteEvents = byteEventMapIt->second; // Callbacks are kept sorted by offset, so we can just walk the queue and // invoke those with offset below provided offset. while (!streamByteEvents.empty()) { // decomposition not supported for xplat const auto cbOffset = streamByteEvents.front().offset; const auto callback = streamByteEvents.front().callback; if (!offset.has_value() || cbOffset < *offset) { streamByteEvents.pop_front(); ByteEventCancellation cancellation{id, cbOffset, type}; callback->onByteEventCanceled(cancellation); if (closeState_ != CloseState::OPEN) { // socket got closed - we can't use streamByteEvents anymore, // closeImpl should take care of cleaning up any remaining callbacks return; } } else { // Only larger or equal offsets left, exit the loop. break; } } // Clean up state for this stream if no callbacks left to invoke. if (streamByteEvents.empty()) { switch (type) { case ByteEvent::Type::ACK: conn_->streamManager->removeDeliverable(id); break; case ByteEvent::Type::TX: conn_->streamManager->removeTx(id); break; } // The callback could have changed the map so erase by id. byteEventMap.erase(id); } } void QuicTransportBase::cancelAllByteEventCallbacks() { invokeForEachByteEventType( ([this](const ByteEvent::Type type) { cancelByteEventCallbacks(type); })); } void QuicTransportBase::cancelByteEventCallbacks(const ByteEvent::Type type) { ByteEventMap byteEventMap = std::move(getByteEventMap(type)); for (const auto& [streamId, cbMap] : byteEventMap) { for (const auto& [offset, cb] : cbMap) { ByteEventCancellation cancellation{streamId, offset, type}; cb->onByteEventCanceled(cancellation); } } } size_t QuicTransportBase::getNumByteEventCallbacksForStream( const StreamId id) const { size_t total = 0; invokeForEachByteEventTypeConst( ([this, id, &total](const ByteEvent::Type type) { total += getNumByteEventCallbacksForStream(type, id); })); return total; } size_t QuicTransportBase::getNumByteEventCallbacksForStream( const ByteEvent::Type type, const StreamId id) const { const auto& byteEventMap = getByteEventMapConst(type); const auto byteEventMapIt = byteEventMap.find(id); if (byteEventMapIt == byteEventMap.end()) { return 0; } const auto& streamByteEvents = byteEventMapIt->second; return streamByteEvents.size(); } folly::Expected, LocalErrorCode> QuicTransportBase::read( StreamId id, size_t maxLen) { if (isSendingStream(conn_->nodeType, id)) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } [[maybe_unused]] auto self = sharedGuard(); SCOPE_EXIT { updateReadLooper(); updatePeekLooper(); // read can affect "peek" API updateWriteLooper(true); }; try { if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(id)); auto result = readDataFromQuicStream(*stream, maxLen); if (result.second) { VLOG(10) << "Delivered eof to app for stream=" << stream->id << " " << *this; auto it = readCallbacks_.find(id); if (it != readCallbacks_.end()) { // it's highly unlikely that someone called read() without having a read // callback so we don't deal with the case of someone installing a read // callback after reading the EOM. it->second.deliveredEOM = true; } } return folly::makeExpected(std::move(result)); } catch (const QuicTransportException& ex) { VLOG(4) << "read() error " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl( QuicError(QuicErrorCode(ex.errorCode()), std::string("read() error"))); return folly::makeUnexpected(LocalErrorCode::TRANSPORT_ERROR); } catch (const QuicInternalException& ex) { VLOG(4) << __func__ << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl( QuicError(QuicErrorCode(ex.errorCode()), std::string("read() error"))); return folly::makeUnexpected(ex.errorCode()); } catch (const std::exception& ex) { VLOG(4) << "read() error " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(TransportErrorCode::INTERNAL_ERROR), std::string("read() error"))); return folly::makeUnexpected(LocalErrorCode::INTERNAL_ERROR); } } folly::Expected QuicTransportBase::peek( StreamId id, const folly::Function&) const>& peekCallback) { if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } [[maybe_unused]] auto self = sharedGuard(); SCOPE_EXIT { updatePeekLooper(); updateWriteLooper(true); }; if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(id)); if (stream->streamReadError) { switch (stream->streamReadError->type()) { case QuicErrorCode::Type::LocalErrorCode: return folly::makeUnexpected( *stream->streamReadError->asLocalErrorCode()); default: return folly::makeUnexpected(LocalErrorCode::INTERNAL_ERROR); } } peekDataFromQuicStream(*stream, std::move(peekCallback)); return folly::makeExpected(folly::Unit()); } folly::Expected QuicTransportBase::consume( StreamId id, size_t amount) { if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(id)); auto result = consume(id, stream->currentReadOffset, amount); if (result.hasError()) { return folly::makeUnexpected(result.error().first); } return folly::makeExpected(result.value()); } folly:: Expected>> QuicTransportBase::consume(StreamId id, uint64_t offset, size_t amount) { using ConsumeError = std::pair>; if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected( ConsumeError{LocalErrorCode::CONNECTION_CLOSED, folly::none}); } [[maybe_unused]] auto self = sharedGuard(); SCOPE_EXIT { updatePeekLooper(); updateReadLooper(); // consume may affect "read" API updateWriteLooper(true); }; folly::Optional readOffset; try { // Need to check that the stream exists first so that we don't // accidentally let the API create a peer stream that was not // sent by the peer. if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected( ConsumeError{LocalErrorCode::STREAM_NOT_EXISTS, readOffset}); } auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(id)); readOffset = stream->currentReadOffset; if (stream->currentReadOffset != offset) { return folly::makeUnexpected( ConsumeError{LocalErrorCode::INTERNAL_ERROR, readOffset}); } if (stream->streamReadError) { switch (stream->streamReadError->type()) { case QuicErrorCode::Type::LocalErrorCode: return folly::makeUnexpected(ConsumeError{ *stream->streamReadError->asLocalErrorCode(), folly::none}); default: return folly::makeUnexpected( ConsumeError{LocalErrorCode::INTERNAL_ERROR, folly::none}); } } consumeDataFromQuicStream(*stream, amount); return folly::makeExpected(folly::Unit()); } catch (const QuicTransportException& ex) { VLOG(4) << "consume() error " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(ex.errorCode()), std::string("consume() error"))); return folly::makeUnexpected( ConsumeError{LocalErrorCode::TRANSPORT_ERROR, readOffset}); } catch (const QuicInternalException& ex) { VLOG(4) << __func__ << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(ex.errorCode()), std::string("consume() error"))); return folly::makeUnexpected(ConsumeError{ex.errorCode(), readOffset}); } catch (const std::exception& ex) { VLOG(4) << "consume() error " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(TransportErrorCode::INTERNAL_ERROR), std::string("consume() error"))); return folly::makeUnexpected( ConsumeError{LocalErrorCode::INTERNAL_ERROR, readOffset}); } } void QuicTransportBase::handlePingCallbacks() { if (conn_->pendingEvents.notifyPingReceived && pingCallback_ != nullptr) { conn_->pendingEvents.notifyPingReceived = false; if (pingCallback_ != nullptr) { pingCallback_->onPing(); } } if (!conn_->pendingEvents.cancelPingTimeout) { return; // nothing to cancel } if (!isTimeoutScheduled(&pingTimeout_)) { // set cancelpingTimeOut to false, delayed acks conn_->pendingEvents.cancelPingTimeout = false; return; // nothing to do, as timeout has already fired } cancelTimeout(&pingTimeout_); if (pingCallback_ != nullptr) { pingCallback_->pingAcknowledged(); } conn_->pendingEvents.cancelPingTimeout = false; } void QuicTransportBase::processCallbacksAfterWriteData() { if (closeState_ != CloseState::OPEN) { return; } auto txStreamId = conn_->streamManager->popTx(); while (txStreamId.has_value()) { auto streamId = *txStreamId; auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(streamId)); auto largestOffsetTxed = getLargestWriteOffsetTxed(*stream); // if it's in the set of streams with TX, we should have a valid offset CHECK(largestOffsetTxed.has_value()); // lambda to help get the next callback to call for this stream auto getNextTxCallbackForStreamAndCleanup = [this, &largestOffsetTxed]( const auto& streamId) -> folly::Optional { auto txCallbacksForStreamIt = txCallbacks_.find(streamId); if (txCallbacksForStreamIt == txCallbacks_.end() || txCallbacksForStreamIt->second.empty()) { return folly::none; } auto& txCallbacksForStream = txCallbacksForStreamIt->second; if (txCallbacksForStream.front().offset > *largestOffsetTxed) { return folly::none; } // extract the callback, pop from the queue, then check for cleanup auto result = txCallbacksForStream.front(); txCallbacksForStream.pop_front(); if (txCallbacksForStream.empty()) { txCallbacks_.erase(txCallbacksForStreamIt); } return result; }; folly::Optional nextOffsetAndCallback; while ( (nextOffsetAndCallback = getNextTxCallbackForStreamAndCleanup(streamId))) { ByteEvent byteEvent{ streamId, nextOffsetAndCallback->offset, ByteEvent::Type::TX}; nextOffsetAndCallback->callback->onByteEvent(byteEvent); // connection may be closed by callback if (closeState_ != CloseState::OPEN) { return; } } // pop the next stream txStreamId = conn_->streamManager->popTx(); } } void QuicTransportBase::handleKnobCallbacks() { if (!conn_->transportSettings.advertisedKnobFrameSupport) { VLOG(4) << "Received knob frames without advertising support"; conn_->pendingEvents.knobs.clear(); return; } for (auto& knobFrame : conn_->pendingEvents.knobs) { if (knobFrame.knobSpace != kDefaultQuicTransportKnobSpace) { if (getSocketObserverContainer() && getSocketObserverContainer() ->hasObserversForEvent< SocketObserverInterface::Events::knobFrameEvents>()) { getSocketObserverContainer() ->invokeInterfaceMethod< SocketObserverInterface::Events::knobFrameEvents>( [event = quic::SocketObserverInterface::KnobFrameEvent( Clock::now(), knobFrame)](auto observer, auto observed) { observer->knobFrameReceived(observed, event); }); } connCallback_->onKnob( knobFrame.knobSpace, knobFrame.id, std::move(knobFrame.blob)); } else { // KnobId is ignored onTransportKnobs(std::move(knobFrame.blob)); } } conn_->pendingEvents.knobs.clear(); } void QuicTransportBase::handleAckEventCallbacks() { auto& lastProcessedAckEvents = conn_->lastProcessedAckEvents; if (lastProcessedAckEvents.empty()) { return; // nothing to do } if (getSocketObserverContainer() && getSocketObserverContainer() ->hasObserversForEvent< SocketObserverInterface::Events::acksProcessedEvents>()) { getSocketObserverContainer() ->invokeInterfaceMethod< SocketObserverInterface::Events::acksProcessedEvents>( [event = quic::SocketObserverInterface::AcksProcessedEvent::Builder() .setAckEvents(lastProcessedAckEvents) .build()](auto observer, auto observed) { observer->acksProcessed(observed, event); }); } lastProcessedAckEvents.clear(); } void QuicTransportBase::handleCancelByteEventCallbacks() { for (auto pendingResetIt = conn_->pendingEvents.resets.begin(); pendingResetIt != conn_->pendingEvents.resets.end(); pendingResetIt++) { cancelByteEventCallbacksForStream(pendingResetIt->first); if (closeState_ != CloseState::OPEN) { return; } } } void QuicTransportBase::logStreamOpenEvent(StreamId streamId) { if (getSocketObserverContainer() && getSocketObserverContainer() ->hasObserversForEvent< SocketObserverInterface::Events::streamEvents>()) { getSocketObserverContainer() ->invokeInterfaceMethod( [event = SocketObserverInterface::StreamOpenEvent( streamId, getStreamInitiator(streamId), getStreamDirectionality(streamId))]( auto observer, auto observed) { observer->streamOpened(observed, event); }); } } void QuicTransportBase::handleNewStreams(std::vector& streamStorage) { const auto& newPeerStreamIds = streamStorage; for (const auto& streamId : newPeerStreamIds) { CHECK_NOTNULL(connCallback_.get()); if (isBidirectionalStream(streamId)) { connCallback_->onNewBidirectionalStream(streamId); } else { connCallback_->onNewUnidirectionalStream(streamId); } logStreamOpenEvent(streamId); if (closeState_ != CloseState::OPEN) { return; } } streamStorage.clear(); } void QuicTransportBase::handleNewGroupedStreams( std::vector& streamStorage) { const auto& newPeerStreamIds = streamStorage; for (const auto& streamId : newPeerStreamIds) { CHECK_NOTNULL(connCallback_.get()); auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(streamId)); CHECK(stream->groupId); if (isBidirectionalStream(streamId)) { connCallback_->onNewBidirectionalStreamInGroup( streamId, *stream->groupId); } else { connCallback_->onNewUnidirectionalStreamInGroup( streamId, *stream->groupId); } logStreamOpenEvent(streamId); if (closeState_ != CloseState::OPEN) { return; } } streamStorage.clear(); } void QuicTransportBase::handleNewStreamCallbacks( std::vector& streamStorage) { streamStorage = conn_->streamManager->consumeNewPeerStreams(); handleNewStreams(streamStorage); } void QuicTransportBase::handleNewGroupedStreamCallbacks( std::vector& streamStorage) { auto newStreamGroups = conn_->streamManager->consumeNewPeerStreamGroups(); for (auto newStreamGroupId : newStreamGroups) { if (isBidirectionalStream(newStreamGroupId)) { connCallback_->onNewBidirectionalStreamGroup(newStreamGroupId); } else { connCallback_->onNewUnidirectionalStreamGroup(newStreamGroupId); } } streamStorage = conn_->streamManager->consumeNewGroupedPeerStreams(); handleNewGroupedStreams(streamStorage); } void QuicTransportBase::handleDeliveryCallbacks() { auto deliverableStreamId = conn_->streamManager->popDeliverable(); while (deliverableStreamId.has_value()) { auto streamId = *deliverableStreamId; auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(streamId)); auto maxOffsetToDeliver = getLargestDeliverableOffset(*stream); while (maxOffsetToDeliver.has_value()) { auto deliveryCallbacksForAckedStream = deliveryCallbacks_.find(streamId); if (deliveryCallbacksForAckedStream == deliveryCallbacks_.end() || deliveryCallbacksForAckedStream->second.empty()) { break; } if (deliveryCallbacksForAckedStream->second.front().offset > *maxOffsetToDeliver) { break; } auto deliveryCallbackAndOffset = deliveryCallbacksForAckedStream->second.front(); deliveryCallbacksForAckedStream->second.pop_front(); auto currentDeliveryCallbackOffset = deliveryCallbackAndOffset.offset; auto deliveryCallback = deliveryCallbackAndOffset.callback; ByteEvent byteEvent{ streamId, currentDeliveryCallbackOffset, ByteEvent::Type::ACK, conn_->lossState.srtt}; deliveryCallback->onByteEvent(byteEvent); if (closeState_ != CloseState::OPEN) { return; } } auto deliveryCallbacksForAckedStream = deliveryCallbacks_.find(streamId); if (deliveryCallbacksForAckedStream != deliveryCallbacks_.end() && deliveryCallbacksForAckedStream->second.empty()) { deliveryCallbacks_.erase(deliveryCallbacksForAckedStream); } deliverableStreamId = conn_->streamManager->popDeliverable(); } } void QuicTransportBase::handleStreamFlowControlUpdatedCallbacks( std::vector& streamStorage) { // Iterate over streams that changed their flow control window and give // their registered listeners their updates. // We don't really need flow control notifications when we are closed. streamStorage = conn_->streamManager->consumeFlowControlUpdated(); const auto& flowControlUpdated = streamStorage; for (auto streamId : flowControlUpdated) { auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(streamId)); if (!stream->writable()) { pendingWriteCallbacks_.erase(streamId); continue; } connCallback_->onFlowControlUpdate(streamId); if (closeState_ != CloseState::OPEN) { return; } // In case the callback modified the stream map, get it again. stream = CHECK_NOTNULL(conn_->streamManager->getStream(streamId)); auto maxStreamWritable = maxWritableOnStream(*stream); if (maxStreamWritable != 0 && !pendingWriteCallbacks_.empty()) { auto pendingWriteIt = pendingWriteCallbacks_.find(stream->id); if (pendingWriteIt != pendingWriteCallbacks_.end()) { auto wcb = pendingWriteIt->second; pendingWriteCallbacks_.erase(stream->id); wcb->onStreamWriteReady(stream->id, maxStreamWritable); if (closeState_ != CloseState::OPEN) { return; } } } } streamStorage.clear(); } void QuicTransportBase::handleStreamStopSendingCallbacks() { const auto stopSendingStreamsCopy = conn_->streamManager->consumeStopSending(); for (const auto& itr : stopSendingStreamsCopy) { connCallback_->onStopSending(itr.first, itr.second); if (closeState_ != CloseState::OPEN) { return; } } } void QuicTransportBase::handleConnWritable() { auto maxConnWrite = maxWritableOnConn(); if (maxConnWrite != 0) { // If the connection now has flow control, we may either have been blocked // before on a pending write to the conn, or a stream's write. if (connWriteCallback_) { auto connWriteCallback = connWriteCallback_; connWriteCallback_ = nullptr; connWriteCallback->onConnectionWriteReady(maxConnWrite); } // If the connection flow control is unblocked, we might be unblocked // on the streams now. auto writeCallbackIt = pendingWriteCallbacks_.begin(); while (writeCallbackIt != pendingWriteCallbacks_.end()) { auto streamId = writeCallbackIt->first; auto wcb = writeCallbackIt->second; ++writeCallbackIt; auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(streamId)); if (!stream->writable()) { pendingWriteCallbacks_.erase(streamId); continue; } auto maxStreamWritable = maxWritableOnStream(*stream); if (maxStreamWritable != 0) { pendingWriteCallbacks_.erase(streamId); wcb->onStreamWriteReady(streamId, maxStreamWritable); if (closeState_ != CloseState::OPEN) { return; } } } } } void QuicTransportBase::cleanupAckEventState() { // if there's no bytes in flight, clear any memory allocated for AckEvents if (conn_->outstandings.packets.empty()) { std::vector empty; conn_->lastProcessedAckEvents.swap(empty); } // memory allocated for vector will be freed } void QuicTransportBase::processCallbacksAfterNetworkData() { if (closeState_ != CloseState::OPEN) { return; } // We reuse this storage for storing streams which need callbacks. std::vector tempStorage; handleNewStreamCallbacks(tempStorage); if (closeState_ != CloseState::OPEN) { return; } handleNewGroupedStreamCallbacks(tempStorage); if (closeState_ != CloseState::OPEN) { return; } handlePingCallbacks(); if (closeState_ != CloseState::OPEN) { return; } handleKnobCallbacks(); if (closeState_ != CloseState::OPEN) { return; } handleAckEventCallbacks(); if (closeState_ != CloseState::OPEN) { return; } handleCancelByteEventCallbacks(); if (closeState_ != CloseState::OPEN) { return; } handleDeliveryCallbacks(); if (closeState_ != CloseState::OPEN) { return; } handleStreamFlowControlUpdatedCallbacks(tempStorage); if (closeState_ != CloseState::OPEN) { return; } handleStreamStopSendingCallbacks(); if (closeState_ != CloseState::OPEN) { return; } handleConnWritable(); if (closeState_ != CloseState::OPEN) { return; } invokeStreamsAvailableCallbacks(); cleanupAckEventState(); } void QuicTransportBase::onNetworkData( const folly::SocketAddress& peer, NetworkData&& networkData) noexcept { [[maybe_unused]] auto self = sharedGuard(); SCOPE_EXIT { checkForClosedStream(); updateReadLooper(); updatePeekLooper(); updateWriteLooper(true); }; try { conn_->lossState.totalBytesRecvd += networkData.getTotalData(); auto originalAckVersion = currentAckStateVersion(*conn_); // handle PacketsReceivedEvent if requested by observers if (getSocketObserverContainer() && getSocketObserverContainer() ->hasObserversForEvent< SocketObserverInterface::Events::packetsReceivedEvents>()) { auto builder = SocketObserverInterface::PacketsReceivedEvent::Builder() .setReceiveLoopTime(TimePoint::clock::now()) .setNumPacketsReceived(networkData.getPackets().size()) .setNumBytesReceived(networkData.getTotalData()); for (auto& packet : networkData.getPackets()) { builder.addReceivedUdpPacket( SocketObserverInterface::PacketsReceivedEvent::ReceivedUdpPacket:: Builder() .setPacketReceiveTime(packet.timings.receiveTimePoint) .setPacketNumBytes(packet.buf->computeChainDataLength()) .build()); } getSocketObserverContainer() ->invokeInterfaceMethod< SocketObserverInterface::Events::packetsReceivedEvents>( [event = std::move(builder).build()]( auto observer, auto observed) { observer->packetsReceived(observed, event); }); } auto packets = std::move(networkData).movePackets(); for (auto& packet : packets) { onReadData(peer, std::move(packet)); if (conn_->peerConnectionError) { closeImpl(QuicError( QuicErrorCode(TransportErrorCode::NO_ERROR), "Peer closed")); return; } } processCallbacksAfterNetworkData(); if (closeState_ != CloseState::CLOSED) { if (currentAckStateVersion(*conn_) != originalAckVersion) { setIdleTimer(); conn_->receivedNewPacketBeforeWrite = true; if (conn_->loopDetectorCallback) { conn_->readDebugState.noReadReason = NoReadReason::READ_OK; conn_->readDebugState.loopCount = 0; } } else if (conn_->loopDetectorCallback) { conn_->readDebugState.noReadReason = NoReadReason::STALE_DATA; conn_->loopDetectorCallback->onSuspiciousReadLoops( ++conn_->readDebugState.loopCount, conn_->readDebugState.noReadReason); } // Reading data could process an ack and change the loss timer. setLossDetectionAlarm(*conn_, *self); // Reading data could change the state of the acks which could change // the ack timer. But we need to call scheduleAckTimeout() for it to // take effect. scheduleAckTimeout(); // Received data could contain valid path response, in which case // path validation timeout should be canceled schedulePathValidationTimeout(); } else { // In the closed state, we would want to write a close if possible // however the write looper will not be set. writeSocketData(); } } catch (const QuicTransportException& ex) { VLOG(4) << __func__ << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); return closeImpl( QuicError(QuicErrorCode(ex.errorCode()), std::string(ex.what()))); } catch (const QuicInternalException& ex) { VLOG(4) << __func__ << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); return closeImpl( QuicError(QuicErrorCode(ex.errorCode()), std::string(ex.what()))); } catch (const QuicApplicationException& ex) { VLOG(4) << __func__ << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); return closeImpl( QuicError(QuicErrorCode(ex.errorCode()), std::string(ex.what()))); } catch (const std::exception& ex) { VLOG(4) << __func__ << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); return closeImpl(QuicError( QuicErrorCode(TransportErrorCode::INTERNAL_ERROR), std::string("error onNetworkData()"))); } } void QuicTransportBase::setIdleTimer() { if (closeState_ == CloseState::CLOSED) { return; } cancelTimeout(&idleTimeout_); cancelTimeout(&keepaliveTimeout_); auto localIdleTimeout = conn_->transportSettings.idleTimeout; // The local idle timeout being zero means it is disabled. if (localIdleTimeout == 0ms) { return; } auto peerIdleTimeout = conn_->peerIdleTimeout > 0ms ? conn_->peerIdleTimeout : localIdleTimeout; auto idleTimeout = timeMin(localIdleTimeout, peerIdleTimeout); scheduleTimeout(&idleTimeout_, idleTimeout); auto idleTimeoutCount = idleTimeout.count(); if (conn_->transportSettings.enableKeepalive) { std::chrono::milliseconds keepaliveTimeout = std::chrono::milliseconds( idleTimeoutCount - static_cast(idleTimeoutCount * .15)); scheduleTimeout(&keepaliveTimeout_, keepaliveTimeout); } } uint64_t QuicTransportBase::getNumOpenableBidirectionalStreams() const { return conn_->streamManager->openableLocalBidirectionalStreams(); } uint64_t QuicTransportBase::getNumOpenableUnidirectionalStreams() const { return conn_->streamManager->openableLocalUnidirectionalStreams(); } folly::Expected QuicTransportBase::createStreamInternal( bool bidirectional, const folly::Optional& streamGroupId) { if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } folly::Expected streamResult; if (bidirectional) { streamResult = conn_->streamManager->createNextBidirectionalStream(streamGroupId); } else { streamResult = conn_->streamManager->createNextUnidirectionalStream(streamGroupId); } if (streamResult) { const StreamId streamId = streamResult.value()->id; if (getSocketObserverContainer() && getSocketObserverContainer() ->hasObserversForEvent< SocketObserverInterface::Events::streamEvents>()) { getSocketObserverContainer() ->invokeInterfaceMethod< SocketObserverInterface::Events::streamEvents>( [event = SocketObserverInterface::StreamOpenEvent( streamId, getStreamInitiator(streamId), getStreamDirectionality(streamId))]( auto observer, auto observed) { observer->streamOpened(observed, event); }); } return streamId; } else { return folly::makeUnexpected(streamResult.error()); } } folly::Expected QuicTransportBase::createBidirectionalStream(bool /*replaySafe*/) { return createStreamInternal(true); } folly::Expected QuicTransportBase::createUnidirectionalStream(bool /*replaySafe*/) { return createStreamInternal(false); } folly::Expected QuicTransportBase::createBidirectionalStreamGroup() { if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } return conn_->streamManager->createNextBidirectionalStreamGroup(); } folly::Expected QuicTransportBase::createUnidirectionalStreamGroup() { if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } return conn_->streamManager->createNextUnidirectionalStreamGroup(); } folly::Expected QuicTransportBase::createBidirectionalStreamInGroup(StreamGroupId groupId) { return createStreamInternal(true, groupId); } folly::Expected QuicTransportBase::createUnidirectionalStreamInGroup(StreamGroupId groupId) { return createStreamInternal(false, groupId); } bool QuicTransportBase::isClientStream(StreamId stream) noexcept { return quic::isClientStream(stream); } bool QuicTransportBase::isServerStream(StreamId stream) noexcept { return quic::isServerStream(stream); } StreamInitiator QuicTransportBase::getStreamInitiator( StreamId stream) noexcept { return quic::getStreamInitiator(conn_->nodeType, stream); } bool QuicTransportBase::isUnidirectionalStream(StreamId stream) noexcept { return quic::isUnidirectionalStream(stream); } bool QuicTransportBase::isBidirectionalStream(StreamId stream) noexcept { return quic::isBidirectionalStream(stream); } StreamDirectionality QuicTransportBase::getStreamDirectionality( StreamId stream) noexcept { return quic::getStreamDirectionality(stream); } folly::Expected QuicTransportBase::notifyPendingWriteOnConnection(WriteCallback* wcb) { if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } if (connWriteCallback_ != nullptr) { return folly::makeUnexpected(LocalErrorCode::INVALID_WRITE_CALLBACK); } // Assign the write callback before going into the loop so that if we close // the connection while we are still scheduled, the write callback will get // an error synchronously. connWriteCallback_ = wcb; runOnEvbAsync([](auto self) { if (!self->connWriteCallback_) { // The connection was probably closed. return; } auto connWritableBytes = self->maxWritableOnConn(); if (connWritableBytes != 0) { auto connWriteCallback = self->connWriteCallback_; self->connWriteCallback_ = nullptr; connWriteCallback->onConnectionWriteReady(connWritableBytes); } }); return folly::unit; } folly::Expected QuicTransportBase::unregisterStreamWriteCallback(StreamId id) { if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } if (pendingWriteCallbacks_.find(id) == pendingWriteCallbacks_.end()) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } pendingWriteCallbacks_.erase(id); return folly::unit; } folly::Expected QuicTransportBase::notifyPendingWriteOnStream(StreamId id, WriteCallback* wcb) { if (isReceivingStream(conn_->nodeType, id)) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(id)); if (!stream->writable()) { return folly::makeUnexpected(LocalErrorCode::STREAM_CLOSED); } if (wcb == nullptr) { return folly::makeUnexpected(LocalErrorCode::INVALID_WRITE_CALLBACK); } // Add the callback to the pending write callbacks so that if we are closed // while we are scheduled in the loop, the close will error out the // callbacks. auto wcbEmplaceResult = pendingWriteCallbacks_.emplace(id, wcb); if (!wcbEmplaceResult.second) { if ((wcbEmplaceResult.first)->second != wcb) { return folly::makeUnexpected(LocalErrorCode::INVALID_WRITE_CALLBACK); } else { return folly::makeUnexpected(LocalErrorCode::CALLBACK_ALREADY_INSTALLED); } } runOnEvbAsync([id](auto self) { auto wcbIt = self->pendingWriteCallbacks_.find(id); if (wcbIt == self->pendingWriteCallbacks_.end()) { // the connection was probably closed. return; } auto writeCallback = wcbIt->second; if (!self->conn_->streamManager->streamExists(id)) { self->pendingWriteCallbacks_.erase(wcbIt); writeCallback->onStreamWriteError( id, QuicError(LocalErrorCode::STREAM_NOT_EXISTS)); return; } auto stream = CHECK_NOTNULL(self->conn_->streamManager->getStream(id)); if (!stream->writable()) { self->pendingWriteCallbacks_.erase(wcbIt); writeCallback->onStreamWriteError( id, QuicError(LocalErrorCode::STREAM_NOT_EXISTS)); return; } auto maxCanWrite = self->maxWritableOnStream(*stream); if (maxCanWrite != 0) { self->pendingWriteCallbacks_.erase(wcbIt); writeCallback->onStreamWriteReady(id, maxCanWrite); } }); return folly::unit; } uint64_t QuicTransportBase::maxWritableOnStream( const QuicStreamState& stream) const { auto connWritableBytes = maxWritableOnConn(); auto streamFlowControlBytes = getSendStreamFlowControlBytesAPI(stream); return std::min(streamFlowControlBytes, connWritableBytes); } uint64_t QuicTransportBase::maxWritableOnConn() const { auto connWritableBytes = getSendConnFlowControlBytesAPI(*conn_); auto availableBufferSpace = bufferSpaceAvailable(); uint64_t ret = std::min(connWritableBytes, availableBufferSpace); uint8_t multiplier = conn_->transportSettings.backpressureHeadroomFactor; if (multiplier > 0) { auto headRoom = multiplier * congestionControlWritableBytes(*conn_); auto bufferLen = conn_->flowControlState.sumCurStreamBufferLen; headRoom -= bufferLen > headRoom ? headRoom : bufferLen; ret = std::min(ret, headRoom); } return ret; } QuicSocket::WriteResult QuicTransportBase::writeChain( StreamId id, Buf data, bool eof, ByteEventCallback* cb) { if (isReceivingStream(conn_->nodeType, id)) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } [[maybe_unused]] auto self = sharedGuard(); try { // Check whether stream exists before calling getStream to avoid // creating a peer stream if it does not exist yet. if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(id)); if (!stream->writable()) { return folly::makeUnexpected(LocalErrorCode::STREAM_CLOSED); } // Register DeliveryCallback for the data + eof offset. if (cb) { auto dataLength = (data ? data->computeChainDataLength() : 0) + (eof ? 1 : 0); if (dataLength) { auto currentLargestWriteOffset = getLargestWriteOffsetSeen(*stream); registerDeliveryCallback( id, currentLargestWriteOffset + dataLength - 1, cb); } } bool wasAppLimitedOrIdle = false; if (conn_->congestionController) { wasAppLimitedOrIdle = conn_->congestionController->isAppLimited(); wasAppLimitedOrIdle |= conn_->streamManager->isAppIdle(); } writeDataToQuicStream(*stream, std::move(data), eof); // If we were previously app limited restart pacing with the current rate. if (wasAppLimitedOrIdle && conn_->pacer) { conn_->pacer->reset(); } updateWriteLooper(true); } catch (const QuicTransportException& ex) { VLOG(4) << __func__ << " streamId=" << id << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(ex.errorCode()), std::string("writeChain() error"))); return folly::makeUnexpected(LocalErrorCode::TRANSPORT_ERROR); } catch (const QuicInternalException& ex) { VLOG(4) << __func__ << " streamId=" << id << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(ex.errorCode()), std::string("writeChain() error"))); return folly::makeUnexpected(ex.errorCode()); } catch (const std::exception& ex) { VLOG(4) << __func__ << " streamId=" << id << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(TransportErrorCode::INTERNAL_ERROR), std::string("writeChain() error"))); return folly::makeUnexpected(LocalErrorCode::INTERNAL_ERROR); } return folly::unit; } QuicSocket::WriteResult QuicTransportBase::writeBufMeta( StreamId id, const BufferMeta& data, bool eof, ByteEventCallback* cb) { if (isReceivingStream(conn_->nodeType, id)) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } [[maybe_unused]] auto self = sharedGuard(); try { // Check whether stream exists before calling getStream to avoid // creating a peer stream if it does not exist yet. if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(id)); if (!stream->writable()) { return folly::makeUnexpected(LocalErrorCode::STREAM_CLOSED); } if (!stream->dsrSender) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } if (stream->currentWriteOffset == 0 && stream->writeBuffer.empty()) { // If nothing has been written to writeBuffer ever, meta writing isn't // allowed. return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } // Register DeliveryCallback for the data + eof offset. if (cb) { auto dataLength = data.length + (eof ? 1 : 0); if (dataLength) { auto currentLargestWriteOffset = getLargestWriteOffsetSeen(*stream); registerDeliveryCallback( id, currentLargestWriteOffset + dataLength - 1, cb); } } bool wasAppLimitedOrIdle = false; if (conn_->congestionController) { wasAppLimitedOrIdle = conn_->congestionController->isAppLimited(); wasAppLimitedOrIdle |= conn_->streamManager->isAppIdle(); } writeBufMetaToQuicStream(*stream, data, eof); // If we were previously app limited restart pacing with the current rate. if (wasAppLimitedOrIdle && conn_->pacer) { conn_->pacer->reset(); } updateWriteLooper(true); } catch (const QuicTransportException& ex) { VLOG(4) << __func__ << " streamId=" << id << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(ex.errorCode()), std::string("writeChain() error"))); return folly::makeUnexpected(LocalErrorCode::TRANSPORT_ERROR); } catch (const QuicInternalException& ex) { VLOG(4) << __func__ << " streamId=" << id << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(ex.errorCode()), std::string("writeChain() error"))); return folly::makeUnexpected(ex.errorCode()); } catch (const std::exception& ex) { VLOG(4) << __func__ << " streamId=" << id << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(TransportErrorCode::INTERNAL_ERROR), std::string("writeChain() error"))); return folly::makeUnexpected(LocalErrorCode::INTERNAL_ERROR); } return folly::unit; } folly::Expected QuicTransportBase::registerDeliveryCallback( StreamId id, uint64_t offset, ByteEventCallback* cb) { return registerByteEventCallback(ByteEvent::Type::ACK, id, offset, cb); } folly::Expected QuicTransportBase::registerTxCallback( StreamId id, uint64_t offset, ByteEventCallback* cb) { return registerByteEventCallback(ByteEvent::Type::TX, id, offset, cb); } folly::Expected QuicTransportBase::registerByteEventCallback( const ByteEvent::Type type, const StreamId id, const uint64_t offset, ByteEventCallback* cb) { if (isReceivingStream(conn_->nodeType, id)) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } [[maybe_unused]] auto self = sharedGuard(); if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } if (!cb) { return folly::unit; } ByteEventMap& byteEventMap = getByteEventMap(type); auto byteEventMapIt = byteEventMap.find(id); if (byteEventMapIt == byteEventMap.end()) { byteEventMap.emplace( id, std::initializer_list::type::mapped_type::value_type>( {{offset, cb}})); } else { // Keep ByteEvents for the same stream sorted by offsets: auto pos = std::upper_bound( byteEventMapIt->second.begin(), byteEventMapIt->second.end(), offset, [&](uint64_t o, const ByteEventDetail& p) { return o < p.offset; }); if (pos != byteEventMapIt->second.begin()) { auto matchingEvent = std::find_if( byteEventMapIt->second.begin(), pos, [offset, cb](const ByteEventDetail& p) { return ((p.offset == offset) && (p.callback == cb)); }); if (matchingEvent != pos) { // ByteEvent has been already registered for the same type, id, // offset and for the same recipient, return an INVALID_OPERATION // error to prevent duplicate registrations. return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } } byteEventMapIt->second.emplace(pos, offset, cb); } auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(id)); // Notify recipients that the registration was successful. cb->onByteEventRegistered(ByteEvent{id, offset, type}); // if the callback is already ready, we still insert, but schedule to // process folly::Optional maxOffsetReady; switch (type) { case ByteEvent::Type::ACK: maxOffsetReady = getLargestDeliverableOffset(*stream); break; case ByteEvent::Type::TX: maxOffsetReady = getLargestWriteOffsetTxed(*stream); break; } if (maxOffsetReady.has_value() && (offset <= *maxOffsetReady)) { runOnEvbAsync([id, cb, offset, type](auto selfObj) { if (selfObj->closeState_ != CloseState::OPEN) { // Close will error out all byte event callbacks. return; } auto& byteEventMapL = selfObj->getByteEventMap(type); auto streamByteEventCbIt = byteEventMapL.find(id); if (streamByteEventCbIt == byteEventMapL.end()) { return; } // This is scheduled to run in the future (during the next iteration of // the event loop). It is possible that the ByteEventDetail list gets // mutated between the time it was scheduled to now when we are ready to // run it. Look at the current outstanding ByteEvents for this stream ID // and confirm that our ByteEvent's offset and recipient callback are // still present. auto pos = std::find_if( streamByteEventCbIt->second.begin(), streamByteEventCbIt->second.end(), [offset, cb](const ByteEventDetail& p) { return ((p.offset == offset) && (p.callback == cb)); }); // if our byteEvent is not present, it must have been delivered already. if (pos == streamByteEventCbIt->second.end()) { return; } streamByteEventCbIt->second.erase(pos); cb->onByteEvent(ByteEvent{id, offset, type}); }); } return folly::unit; } folly::Optional QuicTransportBase::shutdownWrite(StreamId id) { if (isReceivingStream(conn_->nodeType, id)) { return LocalErrorCode::INVALID_OPERATION; } return folly::none; } folly::Expected QuicTransportBase::resetStream( StreamId id, ApplicationErrorCode errorCode) { if (isReceivingStream(conn_->nodeType, id)) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } [[maybe_unused]] auto self = sharedGuard(); SCOPE_EXIT { checkForClosedStream(); updateReadLooper(); updatePeekLooper(); updateWriteLooper(true); }; try { // Check whether stream exists before calling getStream to avoid // creating a peer stream if it does not exist yet. if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(id)); // Invoke state machine sendRstSMHandler(*stream, errorCode); for (auto pendingResetIt = conn_->pendingEvents.resets.begin(); closeState_ == CloseState::OPEN && pendingResetIt != conn_->pendingEvents.resets.end(); pendingResetIt++) { cancelByteEventCallbacksForStream(pendingResetIt->first); } pendingWriteCallbacks_.erase(id); QUIC_STATS(conn_->statsCallback, onQuicStreamReset, errorCode); } catch (const QuicTransportException& ex) { VLOG(4) << __func__ << " streamId=" << id << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(ex.errorCode()), std::string("resetStream() error"))); return folly::makeUnexpected(LocalErrorCode::TRANSPORT_ERROR); } catch (const QuicInternalException& ex) { VLOG(4) << __func__ << " streamId=" << id << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(ex.errorCode()), std::string("resetStream() error"))); return folly::makeUnexpected(ex.errorCode()); } catch (const std::exception& ex) { VLOG(4) << __func__ << " streamId=" << id << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(TransportErrorCode::INTERNAL_ERROR), std::string("resetStream() error"))); return folly::makeUnexpected(LocalErrorCode::INTERNAL_ERROR); } return folly::unit; } void QuicTransportBase::checkForClosedStream() { if (closeState_ == CloseState::CLOSED) { return; } auto itr = conn_->streamManager->closedStreams().begin(); while (itr != conn_->streamManager->closedStreams().end()) { const auto& streamId = *itr; if (getSocketObserverContainer() && getSocketObserverContainer() ->hasObserversForEvent< SocketObserverInterface::Events::streamEvents>()) { getSocketObserverContainer() ->invokeInterfaceMethod< SocketObserverInterface::Events::streamEvents>( [event = SocketObserverInterface::StreamCloseEvent( streamId, getStreamInitiator(streamId), getStreamDirectionality(streamId))]( auto observer, auto observed) { observer->streamClosed(observed, event); }); } // We may be in an active read cb when we close the stream auto readCbIt = readCallbacks_.find(*itr); // We use the read callback as a way to defer destruction of the stream. if (readCbIt != readCallbacks_.end() && readCbIt->second.readCb != nullptr) { if (conn_->transportSettings.removeStreamAfterEomCallbackUnset || !readCbIt->second.deliveredEOM) { VLOG(10) << "Not closing stream=" << *itr << " because it has active read callback"; ++itr; continue; } } // We may be in the active peek cb when we close the stream auto peekCbIt = peekCallbacks_.find(*itr); if (peekCbIt != peekCallbacks_.end() && peekCbIt->second.peekCb != nullptr) { VLOG(10) << "Not closing stream=" << *itr << " because it has active peek callback"; ++itr; continue; } // If we have pending byte events, delay closing the stream auto numByteEventCb = getNumByteEventCallbacksForStream(*itr); if (numByteEventCb > 0) { VLOG(10) << "Not closing stream=" << *itr << " because it has " << numByteEventCb << " pending byte event callbacks"; ++itr; continue; } VLOG(10) << "Closing stream=" << *itr; if (conn_->qLogger) { conn_->qLogger->addTransportStateUpdate( getClosingStream(folly::to(*itr))); } if (connCallback_) { connCallback_->onStreamPreReaped(*itr); } conn_->streamManager->removeClosedStream(*itr); maybeSendStreamLimitUpdates(*conn_); if (readCbIt != readCallbacks_.end()) { readCallbacks_.erase(readCbIt); } if (peekCbIt != peekCallbacks_.end()) { peekCallbacks_.erase(peekCbIt); } itr = conn_->streamManager->closedStreams().erase(itr); } // while if (closeState_ == CloseState::GRACEFUL_CLOSING && conn_->streamManager->streamCount() == 0) { closeImpl(folly::none); } } folly::Expected QuicTransportBase::setPingCallback( PingCallback* cb) { if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } VLOG(4) << "Setting ping callback " << " cb=" << cb << " " << *this; pingCallback_ = cb; return folly::unit; } void QuicTransportBase::sendPing(std::chrono::milliseconds pingTimeout) { /* Step 0: Connection should not be closed */ if (closeState_ == CloseState::CLOSED) { return; } // Step 1: Send a simple ping frame conn_->pendingEvents.sendPing = true; updateWriteLooper(true); // Step 2: Schedule the timeout on event base if (pingCallback_ && pingTimeout != 0ms) { schedulePingTimeout(pingCallback_, pingTimeout); } } void QuicTransportBase::lossTimeoutExpired() noexcept { CHECK_NE(closeState_, CloseState::CLOSED); // onLossDetectionAlarm will set packetToSend in pending events [[maybe_unused]] auto self = sharedGuard(); try { onLossDetectionAlarm(*conn_, markPacketLoss); if (conn_->qLogger) { conn_->qLogger->addTransportStateUpdate(kLossTimeoutExpired); } pacedWriteDataToSocket(); } catch (const QuicTransportException& ex) { VLOG(4) << __func__ << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(ex.errorCode()), std::string("lossTimeoutExpired() error"))); } catch (const QuicInternalException& ex) { VLOG(4) << __func__ << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(ex.errorCode()), std::string("lossTimeoutExpired() error"))); } catch (const std::exception& ex) { VLOG(4) << __func__ << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(TransportErrorCode::INTERNAL_ERROR), std::string("lossTimeoutExpired() error"))); } } void QuicTransportBase::ackTimeoutExpired() noexcept { CHECK_NE(closeState_, CloseState::CLOSED); VLOG(10) << __func__ << " " << *this; [[maybe_unused]] auto self = sharedGuard(); updateAckStateOnAckTimeout(*conn_); pacedWriteDataToSocket(); } void QuicTransportBase::pingTimeoutExpired() noexcept { // If timeout expired just call the call back Provided if (pingCallback_ != nullptr) { pingCallback_->pingTimeout(); } } void QuicTransportBase::excessWriteTimeoutExpired() noexcept { auto writeDataReason = shouldWriteData(*conn_); if (writeDataReason != WriteDataReason::NO_WRITE) { pacedWriteDataToSocket(); } } void QuicTransportBase::pathValidationTimeoutExpired() noexcept { CHECK(conn_->outstandingPathValidation); conn_->pendingEvents.schedulePathValidationTimeout = false; conn_->outstandingPathValidation.reset(); if (conn_->qLogger) { conn_->qLogger->addPathValidationEvent(false); } // TODO junqiw probing is not supported, so pathValidation==connMigration // We decide to close conn when pathValidation to migrated path fails. [[maybe_unused]] auto self = sharedGuard(); closeImpl(QuicError( QuicErrorCode(TransportErrorCode::INVALID_MIGRATION), std::string("Path validation timed out"))); } void QuicTransportBase::idleTimeoutExpired(bool drain) noexcept { VLOG(4) << __func__ << " " << *this; [[maybe_unused]] auto self = sharedGuard(); // idle timeout is expired, just close the connection and drain or // send connection close immediately depending on 'drain' DCHECK_NE(closeState_, CloseState::CLOSED); uint64_t numOpenStreans = conn_->streamManager->streamCount(); auto localError = drain ? LocalErrorCode::IDLE_TIMEOUT : LocalErrorCode::SHUTTING_DOWN; closeImpl( quic::QuicError( QuicErrorCode(localError), folly::to( toString(localError), ", num non control streams: ", numOpenStreans - conn_->streamManager->numControlStreams())), drain /* drainConnection */, !drain /* sendCloseImmediately */); } void QuicTransportBase::keepaliveTimeoutExpired() noexcept { [[maybe_unused]] auto self = sharedGuard(); conn_->pendingEvents.sendPing = true; updateWriteLooper(true); } void QuicTransportBase::scheduleLossTimeout(std::chrono::milliseconds timeout) { if (closeState_ == CloseState::CLOSED) { return; } timeout = timeMax(timeout, evb_->getTimerTickInterval()); scheduleTimeout(&lossTimeout_, timeout); } void QuicTransportBase::scheduleAckTimeout() { if (closeState_ == CloseState::CLOSED) { return; } if (conn_->pendingEvents.scheduleAckTimeout) { if (!isTimeoutScheduled(&ackTimeout_)) { auto factoredRtt = std::chrono::duration_cast( kAckTimerFactor * conn_->lossState.srtt); // If we are using ACK_FREQUENCY, disable the factored RTT heuristic // and only use the update max ACK delay. if (conn_->ackStates.appDataAckState.ackFrequencySequenceNumber) { factoredRtt = conn_->ackStates.maxAckDelay; } auto timeout = timeMax( std::chrono::duration_cast( evb_->getTimerTickInterval()), timeMin(conn_->ackStates.maxAckDelay, factoredRtt)); auto timeoutMs = folly::chrono::ceil(timeout); VLOG(10) << __func__ << " timeout=" << timeoutMs.count() << "ms" << " factoredRtt=" << factoredRtt.count() << "us" << " " << *this; scheduleTimeout(&ackTimeout_, timeoutMs); } } else { if (isTimeoutScheduled(&ackTimeout_)) { VLOG(10) << __func__ << " cancel timeout " << *this; cancelTimeout(&ackTimeout_); } } } void QuicTransportBase::schedulePingTimeout( PingCallback* pingCb, std::chrono::milliseconds timeout) { // if a ping timeout is already scheduled, nothing to do, return if (isTimeoutScheduled(&pingTimeout_)) { return; } pingCallback_ = pingCb; scheduleTimeout(&pingTimeout_, timeout); } void QuicTransportBase::schedulePathValidationTimeout() { if (closeState_ == CloseState::CLOSED) { return; } if (!conn_->pendingEvents.schedulePathValidationTimeout) { if (isTimeoutScheduled(&pathValidationTimeout_)) { VLOG(10) << __func__ << " cancel timeout " << *this; // This means path validation succeeded, and we should have updated to // correct state cancelTimeout(&pathValidationTimeout_); } } else if (!isTimeoutScheduled(&pathValidationTimeout_)) { auto pto = conn_->lossState.srtt + std::max(4 * conn_->lossState.rttvar, kGranularity) + conn_->lossState.maxAckDelay; auto validationTimeout = std::max(3 * pto, 6 * conn_->transportSettings.initialRtt); auto timeoutMs = folly::chrono::ceil(validationTimeout); VLOG(10) << __func__ << " timeout=" << timeoutMs.count() << "ms " << *this; scheduleTimeout(&pathValidationTimeout_, timeoutMs); } } void QuicTransportBase::cancelLossTimeout() { cancelTimeout(&lossTimeout_); } bool QuicTransportBase::isLossTimeoutScheduled() { return isTimeoutScheduled(&lossTimeout_); } void QuicTransportBase::setSupportedVersions( const std::vector& versions) { conn_->originalVersion = versions.at(0); conn_->supportedVersions = versions; } void QuicTransportBase::setAckRxTimestampsDisabled( bool disableAckRxTimestamps) { if (disableAckRxTimestamps) { conn_->transportSettings.maybeAckReceiveTimestampsConfigSentToPeer.clear(); } } void QuicTransportBase::setConnectionSetupCallback( folly::MaybeManagedPtr callback) { connSetupCallback_ = callback; } void QuicTransportBase::setConnectionCallback( folly::MaybeManagedPtr callback) { connCallback_ = callback; } void QuicTransportBase::setEarlyDataAppParamsFunctions( folly::Function&, const Buf&) const> validator, folly::Function getter) { conn_->earlyDataAppParamsValidator = std::move(validator); conn_->earlyDataAppParamsGetter = std::move(getter); } void QuicTransportBase::cancelAllAppCallbacks(const QuicError& err) noexcept { SCOPE_EXIT { checkForClosedStream(); updateReadLooper(); updatePeekLooper(); updateWriteLooper(true); }; conn_->streamManager->clearActionable(); // Cancel any pending ByteEvent callbacks cancelAllByteEventCallbacks(); // TODO: this will become simpler when we change the underlying data // structure of read callbacks. // TODO: this approach will make the app unable to setReadCallback to // nullptr during the loop. Need to fix that. // TODO: setReadCallback to nullptr closes the stream, so the app // may just do that... auto readCallbacksCopy = readCallbacks_; for (auto& cb : readCallbacksCopy) { readCallbacks_.erase(cb.first); if (cb.second.readCb) { auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(cb.first)); if (!stream->groupId) { cb.second.readCb->readError(cb.first, err); } else { cb.second.readCb->readErrorWithGroup(cb.first, *stream->groupId, err); } } } VLOG(4) << "Clearing datagram callback"; datagramCallback_ = nullptr; VLOG(4) << "Clearing ping callback"; pingCallback_ = nullptr; VLOG(4) << "Clearing " << peekCallbacks_.size() << " peek callbacks"; auto peekCallbacksCopy = peekCallbacks_; for (auto& cb : peekCallbacksCopy) { peekCallbacks_.erase(cb.first); if (cb.second.peekCb) { cb.second.peekCb->peekError(cb.first, err); } } if (connWriteCallback_) { auto connWriteCallback = connWriteCallback_; connWriteCallback_ = nullptr; connWriteCallback->onConnectionWriteError(err); } auto pendingWriteCallbacksCopy = pendingWriteCallbacks_; for (auto& wcb : pendingWriteCallbacksCopy) { pendingWriteCallbacks_.erase(wcb.first); wcb.second->onStreamWriteError(wcb.first, err); } } void QuicTransportBase::resetNonControlStreams( ApplicationErrorCode error, folly::StringPiece errorMsg) { std::vector nonControlStreamIds; nonControlStreamIds.reserve(conn_->streamManager->streamCount()); conn_->streamManager->streamStateForEach( [&nonControlStreamIds](const auto& stream) { if (!stream.isControl) { nonControlStreamIds.push_back(stream.id); } }); for (auto id : nonControlStreamIds) { if (isSendingStream(conn_->nodeType, id) || isBidirectionalStream(id)) { auto writeCallbackIt = pendingWriteCallbacks_.find(id); if (writeCallbackIt != pendingWriteCallbacks_.end()) { writeCallbackIt->second->onStreamWriteError( id, QuicError(error, errorMsg.str())); } resetStream(id, error); } if (isReceivingStream(conn_->nodeType, id) || isBidirectionalStream(id)) { auto readCallbackIt = readCallbacks_.find(id); if (readCallbackIt != readCallbacks_.end() && readCallbackIt->second.readCb) { auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(id)); if (!stream->groupId) { readCallbackIt->second.readCb->readError( id, QuicError(error, errorMsg.str())); } else { readCallbackIt->second.readCb->readErrorWithGroup( id, *stream->groupId, QuicError(error, errorMsg.str())); } } peekCallbacks_.erase(id); stopSending(id, error); } } } QuicConnectionStats QuicTransportBase::getConnectionsStats() const { QuicConnectionStats connStats; if (!conn_) { return connStats; } connStats.peerAddress = conn_->peerAddress; connStats.duration = Clock::now() - conn_->connectionTime; if (conn_->congestionController) { connStats.cwnd_bytes = conn_->congestionController->getCongestionWindow(); connStats.congestionController = conn_->congestionController->type(); conn_->congestionController->getStats(connStats.congestionControllerStats); } connStats.ptoCount = conn_->lossState.ptoCount; connStats.srtt = conn_->lossState.srtt; connStats.mrtt = conn_->lossState.mrtt; connStats.rttvar = conn_->lossState.rttvar; connStats.peerAckDelayExponent = conn_->peerAckDelayExponent; connStats.udpSendPacketLen = conn_->udpSendPacketLen; if (conn_->streamManager) { connStats.numStreams = conn_->streamManager->streams().size(); } if (conn_->clientChosenDestConnectionId.hasValue()) { connStats.clientChosenDestConnectionId = conn_->clientChosenDestConnectionId->hex(); } if (conn_->clientConnectionId.hasValue()) { connStats.clientConnectionId = conn_->clientConnectionId->hex(); } if (conn_->serverConnectionId.hasValue()) { connStats.serverConnectionId = conn_->serverConnectionId->hex(); } connStats.totalBytesSent = conn_->lossState.totalBytesSent; connStats.totalBytesReceived = conn_->lossState.totalBytesRecvd; connStats.totalBytesRetransmitted = conn_->lossState.totalBytesRetransmitted; if (conn_->version.hasValue()) { connStats.version = static_cast(*conn_->version); } return connStats; } folly::Expected QuicTransportBase::setDatagramCallback(DatagramCallback* cb) { if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } VLOG(4) << "Setting datagram callback " << " cb=" << cb << " " << *this; datagramCallback_ = cb; updateReadLooper(); return folly::unit; } uint16_t QuicTransportBase::getDatagramSizeLimit() const { CHECK(conn_); auto maxDatagramPacketSize = std::minudpSendPacketLen)>( conn_->datagramState.maxWriteFrameSize, conn_->udpSendPacketLen); return std::max( 0, maxDatagramPacketSize - kMaxDatagramPacketOverhead); } folly::Expected QuicTransportBase::writeDatagram( Buf buf) { // TODO(lniccolini) update max datagram frame size // https://github.com/quicwg/datagram/issues/3 // For now, max_datagram_size > 0 means the peer supports datagram frames if (conn_->datagramState.maxWriteFrameSize == 0) { QUIC_STATS(conn_->statsCallback, onDatagramDroppedOnWrite); return folly::makeUnexpected(LocalErrorCode::INVALID_WRITE_DATA); } if (conn_->datagramState.writeBuffer.size() >= conn_->datagramState.maxWriteBufferSize) { QUIC_STATS(conn_->statsCallback, onDatagramDroppedOnWrite); if (!conn_->transportSettings.datagramConfig.sendDropOldDataFirst) { // TODO(lniccolini) use different return codes to signal the application // exactly why the datagram got dropped return folly::makeUnexpected(LocalErrorCode::INVALID_WRITE_DATA); } else { conn_->datagramState.writeBuffer.pop_front(); } } conn_->datagramState.writeBuffer.emplace_back(std::move(buf)); updateWriteLooper(true); return folly::unit; } folly::Expected, LocalErrorCode> QuicTransportBase::readDatagrams(size_t atMost) { CHECK(conn_); auto datagrams = &conn_->datagramState.readBuffer; if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } if (atMost == 0) { atMost = datagrams->size(); } else { atMost = std::min(atMost, datagrams->size()); } std::vector retDatagrams; retDatagrams.reserve(atMost); std::transform( datagrams->begin(), datagrams->begin() + atMost, std::back_inserter(retDatagrams), [](ReadDatagram& dg) { return std::move(dg); }); datagrams->erase(datagrams->begin(), datagrams->begin() + atMost); return retDatagrams; } folly::Expected, LocalErrorCode> QuicTransportBase::readDatagramBufs(size_t atMost) { CHECK(conn_); auto datagrams = &conn_->datagramState.readBuffer; if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } if (atMost == 0) { atMost = datagrams->size(); } else { atMost = std::min(atMost, datagrams->size()); } std::vector retDatagrams; retDatagrams.reserve(atMost); std::transform( datagrams->begin(), datagrams->begin() + atMost, std::back_inserter(retDatagrams), [](ReadDatagram& dg) { return dg.bufQueue().move(); }); datagrams->erase(datagrams->begin(), datagrams->begin() + atMost); return retDatagrams; } void QuicTransportBase::writeSocketData() { if (socket_) { ++(conn_->writeCount); // incremented on each write (or write attempt) // record current number of sent packets to detect delta const auto beforeTotalBytesSent = conn_->lossState.totalBytesSent; const auto beforeTotalPacketsSent = conn_->lossState.totalPacketsSent; const auto beforeTotalAckElicitingPacketsSent = conn_->lossState.totalAckElicitingPacketsSent; const auto beforeNumOutstandingPackets = conn_->outstandings.numOutstanding(); updatePacketProcessorsPrewriteRequests(); // if we're starting to write from app limited, notify observers if (conn_->appLimitedTracker.isAppLimited() && conn_->congestionController) { conn_->appLimitedTracker.setNotAppLimited(); notifyStartWritingFromAppRateLimited(); } writeData(); if (closeState_ != CloseState::CLOSED) { if (conn_->pendingEvents.closeTransport == true) { throw QuicTransportException( "Max packet number reached", TransportErrorCode::PROTOCOL_VIOLATION); } setLossDetectionAlarm(*conn_, *this); // check for change in number of packets const auto afterTotalBytesSent = conn_->lossState.totalBytesSent; const auto afterTotalPacketsSent = conn_->lossState.totalPacketsSent; const auto afterTotalAckElicitingPacketsSent = conn_->lossState.totalAckElicitingPacketsSent; const auto afterNumOutstandingPackets = conn_->outstandings.numOutstanding(); CHECK_LE(beforeTotalPacketsSent, afterTotalPacketsSent); CHECK_LE( beforeTotalAckElicitingPacketsSent, afterTotalAckElicitingPacketsSent); CHECK_LE(beforeNumOutstandingPackets, afterNumOutstandingPackets); CHECK_EQ( afterNumOutstandingPackets - beforeNumOutstandingPackets, afterTotalAckElicitingPacketsSent - beforeTotalAckElicitingPacketsSent); const bool newPackets = (afterTotalPacketsSent > beforeTotalPacketsSent); const bool newOutstandingPackets = (afterTotalAckElicitingPacketsSent > beforeTotalAckElicitingPacketsSent); // if packets sent, notify observers if (newPackets) { notifyPacketsWritten( afterTotalPacketsSent - beforeTotalPacketsSent /* numPacketsWritten */, afterTotalAckElicitingPacketsSent - beforeTotalAckElicitingPacketsSent /* numAckElicitingPacketsWritten */, afterTotalBytesSent - beforeTotalBytesSent /* numBytesWritten */); } if (conn_->loopDetectorCallback && newOutstandingPackets) { conn_->writeDebugState.currentEmptyLoopCount = 0; } else if ( conn_->writeDebugState.needsWriteLoopDetect && conn_->loopDetectorCallback) { // TODO: Currently we will to get some stats first. Then we may filter // out some errors here. For example, socket fail to write might be a // legit case to filter out. conn_->loopDetectorCallback->onSuspiciousWriteLoops( ++conn_->writeDebugState.currentEmptyLoopCount, conn_->writeDebugState.writeDataReason, conn_->writeDebugState.noWriteReason, conn_->writeDebugState.schedulerName); } // If we sent a new packet and the new packet was either the first // packet after quiescence or after receiving a new packet. if (newOutstandingPackets && (beforeNumOutstandingPackets == 0 || conn_->receivedNewPacketBeforeWrite)) { // Reset the idle timer because we sent some data. setIdleTimer(); conn_->receivedNewPacketBeforeWrite = false; } // Check if we are app-limited after finish this round of sending auto currentSendBufLen = conn_->flowControlState.sumCurStreamBufferLen; auto lossBufferEmpty = !conn_->streamManager->hasLoss() && conn_->cryptoState->initialStream.lossBuffer.empty() && conn_->cryptoState->handshakeStream.lossBuffer.empty() && conn_->cryptoState->oneRttStream.lossBuffer.empty(); if (conn_->congestionController && currentSendBufLen < conn_->udpSendPacketLen && lossBufferEmpty && conn_->congestionController->getWritableBytes()) { conn_->congestionController->setAppLimited(); // notify via connection call and any observer callbacks if (transportReadyNotified_ && connCallback_) { connCallback_->onAppRateLimited(); } conn_->appLimitedTracker.setAppLimited(); notifyAppRateLimited(); } } } // Writing data could write out an ack which could cause us to cancel // the ack timer. But we need to call scheduleAckTimeout() for it to take // effect. scheduleAckTimeout(); schedulePathValidationTimeout(); updateWriteLooper(false); } void QuicTransportBase::writeSocketDataAndCatch() { [[maybe_unused]] auto self = sharedGuard(); try { writeSocketData(); processCallbacksAfterWriteData(); } catch (const QuicTransportException& ex) { VLOG(4) << __func__ << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(ex.errorCode()), std::string("writeSocketDataAndCatch() error"))); } catch (const QuicInternalException& ex) { VLOG(4) << __func__ << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(ex.errorCode()), std::string("writeSocketDataAndCatch() error"))); } catch (const std::exception& ex) { VLOG(4) << __func__ << " error=" << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(TransportErrorCode::INTERNAL_ERROR), std::string("writeSocketDataAndCatch() error"))); } } void QuicTransportBase::setTransportSettings( TransportSettings transportSettings) { if (conn_->nodeType == QuicNodeType::Client) { if (useSinglePacketInplaceBatchWriter( transportSettings.maxBatchSize, transportSettings.dataPathType)) { createBufAccessor(conn_->udpSendPacketLen); } else if ( transportSettings.dataPathType == quic::DataPathType::ContinuousMemory) { // Create generic buf for in-place batch writer. createBufAccessor( conn_->udpSendPacketLen * transportSettings.maxBatchSize); } } // If transport parameters are encoded, we can only update congestion // control related params. Setting other transport settings again would be // buggy. // TODO should we throw or return Expected here? if (conn_->transportParametersEncoded) { updateCongestionControlSettings(transportSettings); } else { // TODO: We should let chain based GSO to use bufAccessor in the future as // well. CHECK( conn_->bufAccessor || transportSettings.dataPathType != DataPathType::ContinuousMemory); conn_->transportSettings = std::move(transportSettings); conn_->streamManager->refreshTransportSettings(conn_->transportSettings); } // A few values cannot be overridden to be lower than default: // TODO refactor transport settings to avoid having to update params twice. if (conn_->transportSettings.defaultCongestionController != CongestionControlType::None) { conn_->transportSettings.initCwndInMss = std::max(conn_->transportSettings.initCwndInMss, kInitCwndInMss); conn_->transportSettings.minCwndInMss = std::max(conn_->transportSettings.minCwndInMss, kMinCwndInMss); conn_->transportSettings.initCwndInMss = std::max( conn_->transportSettings.minCwndInMss, conn_->transportSettings.initCwndInMss); } validateCongestionAndPacing( conn_->transportSettings.defaultCongestionController); if (conn_->transportSettings.pacingEnabled) { if (writeLooper_->hasPacingTimer()) { bool usingBbr = (conn_->transportSettings.defaultCongestionController == CongestionControlType::BBR || conn_->transportSettings.defaultCongestionController == CongestionControlType::BBRTesting || conn_->transportSettings.defaultCongestionController == CongestionControlType::BBR2); auto minCwnd = usingBbr ? kMinCwndInMssForBbr : conn_->transportSettings.minCwndInMss; conn_->pacer = std::make_unique(*conn_, minCwnd); conn_->pacer->setExperimental(conn_->transportSettings.experimentalPacer); conn_->canBePaced = conn_->transportSettings.pacingEnabledFirstFlight; } else { LOG(ERROR) << "Pacing cannot be enabled without a timer"; conn_->transportSettings.pacingEnabled = false; } } setCongestionControl(conn_->transportSettings.defaultCongestionController); if (conn_->transportSettings.datagramConfig.enabled) { conn_->datagramState.maxReadFrameSize = kMaxDatagramFrameSize; conn_->datagramState.maxReadBufferSize = conn_->transportSettings.datagramConfig.readBufSize; conn_->datagramState.maxWriteBufferSize = conn_->transportSettings.datagramConfig.writeBufSize; } } folly::Expected QuicTransportBase::setMaxPacingRate(uint64_t maxRateBytesPerSec) { if (conn_->pacer) { conn_->pacer->setMaxPacingRate(maxRateBytesPerSec); return folly::unit; } else { LOG(WARNING) << "Cannot set max pacing rate without a pacer. Pacing Enabled = " << conn_->transportSettings.pacingEnabled; return folly::makeUnexpected(LocalErrorCode::PACER_NOT_AVAILABLE); } } void QuicTransportBase::updateCongestionControlSettings( const TransportSettings& transportSettings) { conn_->transportSettings.defaultCongestionController = transportSettings.defaultCongestionController; conn_->transportSettings.initCwndInMss = transportSettings.initCwndInMss; conn_->transportSettings.minCwndInMss = transportSettings.minCwndInMss; conn_->transportSettings.maxCwndInMss = transportSettings.maxCwndInMss; conn_->transportSettings.limitedCwndInMss = transportSettings.limitedCwndInMss; conn_->transportSettings.pacingEnabled = transportSettings.pacingEnabled; conn_->transportSettings.pacingTickInterval = transportSettings.pacingTickInterval; conn_->transportSettings.pacingTimerResolution = transportSettings.pacingTimerResolution; conn_->transportSettings.minBurstPackets = transportSettings.minBurstPackets; conn_->transportSettings.copaDeltaParam = transportSettings.copaDeltaParam; conn_->transportSettings.copaUseRttStanding = transportSettings.copaUseRttStanding; } folly::Expected QuicTransportBase::setKnob(uint64_t knobSpace, uint64_t knobId, Buf knobBlob) { if (isKnobSupported()) { sendSimpleFrame(*conn_, KnobFrame(knobSpace, knobId, std::move(knobBlob))); return folly::unit; } LOG(ERROR) << "Cannot set knob. Peer does not support the knob frame"; return folly::makeUnexpected(LocalErrorCode::KNOB_FRAME_UNSUPPORTED); } bool QuicTransportBase::isKnobSupported() const { return conn_->peerAdvertisedKnobFrameSupport; } const TransportSettings& QuicTransportBase::getTransportSettings() const { return conn_->transportSettings; } folly::Expected QuicTransportBase::setStreamPriority(StreamId id, Priority priority) { if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } if (priority.level > kDefaultMaxPriority) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } if (!conn_->streamManager->streamExists(id)) { // It's not an error to try to prioritize a non-existent stream. return folly::unit; } // It's not an error to prioritize a stream after it's sent its FIN - this // can reprioritize retransmissions. bool updated = conn_->streamManager->setStreamPriority(id, priority); if (updated && conn_->qLogger) { conn_->qLogger->addPriorityUpdate(id, priority.level, priority.incremental); } return folly::unit; } folly::Expected QuicTransportBase::getStreamPriority( StreamId id) { if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } if (auto stream = conn_->streamManager->findStream(id)) { return stream->priority; } return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } void QuicTransportBase::validateCongestionAndPacing( CongestionControlType& type) { // Fallback to Cubic if Pacing isn't enabled with BBR together if ((type == CongestionControlType::BBR || type == CongestionControlType::BBRTesting || type == CongestionControlType::BBR2) && (!conn_->transportSettings.pacingEnabled || !writeLooper_->hasPacingTimer())) { LOG(ERROR) << "Unpaced BBR isn't supported"; type = CongestionControlType::Cubic; } if (type == CongestionControlType::BBR2 || type == CongestionControlType::BBRTesting) { // We need to have the pacer rate be as accurate as possible for BBR2 and // BBRTesting. // The current BBR behavior is dependent on the existing pacing // behavior so the override is only for BBR2. // TODO: This should be removed once the pacer changes are adopted as // the defaults or the pacer is fixed in another way. conn_->transportSettings.experimentalPacer = true; conn_->transportSettings.defaultRttFactor = {1, 1}; conn_->transportSettings.startupRttFactor = {1, 1}; if (conn_->pacer) { conn_->pacer->setExperimental(conn_->transportSettings.experimentalPacer); conn_->pacer->setRttFactor( conn_->transportSettings.defaultRttFactor.first, conn_->transportSettings.defaultRttFactor.second); } writeLooper_->setFireLoopEarly(true); } } void QuicTransportBase::setCongestionControl(CongestionControlType type) { DCHECK(conn_); if (!conn_->congestionController || type != conn_->congestionController->type()) { CHECK(conn_->congestionControllerFactory); validateCongestionAndPacing(type); conn_->congestionController = conn_->congestionControllerFactory->makeCongestionController( *conn_, type); if (conn_->qLogger) { std::stringstream s; s << "CCA set to " << congestionControlTypeToString(type); conn_->qLogger->addTransportStateUpdate(s.str()); } } } void QuicTransportBase::addPacketProcessor( std::shared_ptr packetProcessor) { DCHECK(conn_); conn_->packetProcessors.push_back(std::move(packetProcessor)); } void QuicTransportBase::setThrottlingSignalProvider( std::shared_ptr throttlingSignalProvider) { DCHECK(conn_); conn_->throttlingSignalProvider = throttlingSignalProvider; } bool QuicTransportBase::isDetachable() { // only the client is detachable. return conn_->nodeType == QuicNodeType::Client; } void QuicTransportBase::attachEventBase(std::shared_ptr evbIn) { VLOG(10) << __func__ << " " << *this; DCHECK(!getEventBase()); DCHECK(evbIn && evbIn->isInEventBaseThread()); evb_ = std::move(evbIn); if (socket_) { socket_->attachEventBase(evb_); } scheduleAckTimeout(); schedulePathValidationTimeout(); setIdleTimer(); readLooper_->attachEventBase(evb_); peekLooper_->attachEventBase(evb_); writeLooper_->attachEventBase(evb_); updateReadLooper(); updatePeekLooper(); updateWriteLooper(false); #ifndef MVFST_USE_LIBEV if (getSocketObserverContainer() && getSocketObserverContainer() ->hasObserversForEvent< SocketObserverInterface::Events::evbEvents>()) { getSocketObserverContainer() ->invokeInterfaceMethod( [this](auto observer, auto observed) { observer->evbAttach(observed, evb_.get()); }); } #endif } void QuicTransportBase::detachEventBase() { VLOG(10) << __func__ << " " << *this; DCHECK(getEventBase() && getEventBase()->isInEventBaseThread()); if (socket_) { socket_->detachEventBase(); } connWriteCallback_ = nullptr; pendingWriteCallbacks_.clear(); cancelTimeout(&lossTimeout_); cancelTimeout(&ackTimeout_); cancelTimeout(&pathValidationTimeout_); cancelTimeout(&idleTimeout_); cancelTimeout(&keepaliveTimeout_); cancelTimeout(&drainTimeout_); readLooper_->detachEventBase(); peekLooper_->detachEventBase(); writeLooper_->detachEventBase(); #ifndef MVFST_USE_LIBEV if (getSocketObserverContainer() && getSocketObserverContainer() ->hasObserversForEvent< SocketObserverInterface::Events::evbEvents>()) { getSocketObserverContainer() ->invokeInterfaceMethod( [this](auto observer, auto observed) { observer->evbDetach(observed, evb_.get()); }); } #endif evb_ = nullptr; } folly::Optional QuicTransportBase::setControlStream( StreamId id) { if (!conn_->streamManager->streamExists(id)) { return LocalErrorCode::STREAM_NOT_EXISTS; } auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(id)); conn_->streamManager->setStreamAsControl(*stream); return folly::none; } void QuicTransportBase::runOnEvbAsync( folly::Function)> func) { auto evb = getEventBase(); evb->runInLoop( [self = sharedGuard(), func = std::move(func), evb]() mutable { if (self->getEventBase() != evb) { // The eventbase changed between scheduling the loop and invoking // the callback, ignore this return; } func(std::move(self)); }, true); } void QuicTransportBase::pacedWriteDataToSocket() { [[maybe_unused]] auto self = sharedGuard(); if (!isConnectionPaced(*conn_)) { // Not paced and connection is still open, normal write. Even if pacing is // previously enabled and then gets disabled, and we are here due to a // timeout, we should do a normal write to flush out the residue from // pacing write. writeSocketDataAndCatch(); if (conn_->transportSettings.scheduleTimerForExcessWrites) { // If we still have data to write, yield the event loop now but schedule a // timeout to come around and write again as soon as possible. auto writeDataReason = shouldWriteData(*conn_); if (writeDataReason != WriteDataReason::NO_WRITE && !excessWriteTimeout_.isTimerCallbackScheduled()) { scheduleTimeout(&excessWriteTimeout_, 0ms); } } return; } // We are in the middle of a pacing interval. Leave it be. if (writeLooper_->isPacingScheduled()) { // The next burst is already scheduled. Since the burst size doesn't // depend on much data we currently have in buffer at all, no need to // change anything. return; } // Do a burst write before waiting for an interval. This will also call // updateWriteLooper, but inside FunctionLooper we will ignore that. writeSocketDataAndCatch(); } folly::Expected QuicTransportBase::getStreamTransportInfo(StreamId id) const { if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(id)); auto packets = getNumPacketsTxWithNewData(*stream); return StreamTransportInfo{ stream->totalHolbTime, stream->holbCount, bool(stream->lastHolbTime), packets, stream->streamLossCount, stream->finalWriteOffset, stream->finalReadOffset, stream->streamReadError, stream->streamWriteError}; } void QuicTransportBase::describe(std::ostream& os) const { CHECK(conn_); os << *conn_; } std::ostream& operator<<(std::ostream& os, const QuicTransportBase& qt) { qt.describe(os); return os; } inline std::ostream& operator<<( std::ostream& os, const CloseState& closeState) { switch (closeState) { case CloseState::OPEN: os << "OPEN"; break; case CloseState::GRACEFUL_CLOSING: os << "GRACEFUL_CLOSING"; break; case CloseState::CLOSED: os << "CLOSED"; break; } return os; } folly::Expected QuicTransportBase::maybeResetStreamFromReadError( StreamId id, QuicErrorCode error) { if (quic::ApplicationErrorCode* code = error.asApplicationErrorCode()) { return resetStream(id, *code); } return folly::Expected(folly::unit); } QuicTransportBase::ByteEventMap& QuicTransportBase::getByteEventMap( const ByteEvent::Type type) { switch (type) { case ByteEvent::Type::ACK: return deliveryCallbacks_; case ByteEvent::Type::TX: return txCallbacks_; } LOG(FATAL) << "Unhandled case in getByteEventMap"; folly::assume_unreachable(); } const QuicTransportBase::ByteEventMap& QuicTransportBase::getByteEventMapConst( const ByteEvent::Type type) const { switch (type) { case ByteEvent::Type::ACK: return deliveryCallbacks_; case ByteEvent::Type::TX: return txCallbacks_; } LOG(FATAL) << "Unhandled case in getByteEventMapConst"; folly::assume_unreachable(); } void QuicTransportBase::onTransportKnobs(Buf knobBlob) { // Not yet implemented, VLOG(4) << "Received transport knobs: " << std::string( reinterpret_cast(knobBlob->data()), knobBlob->length()); } QuicSocket::WriteResult QuicTransportBase::setDSRPacketizationRequestSender( StreamId id, std::unique_ptr sender) { if (closeState_ != CloseState::OPEN) { return folly::makeUnexpected(LocalErrorCode::CONNECTION_CLOSED); } if (isReceivingStream(conn_->nodeType, id)) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } [[maybe_unused]] auto self = sharedGuard(); try { // Check whether stream exists before calling getStream to avoid // creating a peer stream if it does not exist yet. if (!conn_->streamManager->streamExists(id)) { return folly::makeUnexpected(LocalErrorCode::STREAM_NOT_EXISTS); } auto stream = CHECK_NOTNULL(conn_->streamManager->getStream(id)); // Only allow resetting it back to nullptr once set. if (stream->dsrSender && sender != nullptr) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } if (stream->dsrSender != nullptr) { // If any of these aren't true then we are abandoning stream data. CHECK_EQ(stream->writeBufMeta.length, 0) << stream; CHECK_EQ(stream->lossBufMetas.size(), 0) << stream; CHECK_EQ(stream->retransmissionBufMetas.size(), 0) << stream; stream->dsrSender->release(); stream->dsrSender = nullptr; return folly::unit; } if (!stream->writable()) { return folly::makeUnexpected(LocalErrorCode::STREAM_CLOSED); } stream->dsrSender = std::move(sender); // Default to disabling opportunistic ACKing for DSR since it causes extra // writes and spurious losses. conn_->transportSettings.opportunisticAcking = false; // Also turn on the default of 5 nexts per stream which has empirically // shown good results. if (conn_->transportSettings.priorityQueueWritesPerStream == 1) { conn_->transportSettings.priorityQueueWritesPerStream = 5; conn_->streamManager->writeQueue().setMaxNextsPerStream(5); } // Fow now, no appLimited or appIdle update here since we are not writing // either BufferMetas yet. The first BufferMeta write will update it. } catch (const QuicTransportException& ex) { VLOG(4) << __func__ << " streamId=" << id << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(ex.errorCode()), std::string("writeChain() error"))); return folly::makeUnexpected(LocalErrorCode::TRANSPORT_ERROR); } catch (const QuicInternalException& ex) { VLOG(4) << __func__ << " streamId=" << id << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(ex.errorCode()), std::string("writeChain() error"))); return folly::makeUnexpected(ex.errorCode()); } catch (const std::exception& ex) { VLOG(4) << __func__ << " streamId=" << id << " " << ex.what() << " " << *this; exceptionCloseWhat_ = ex.what(); closeImpl(QuicError( QuicErrorCode(TransportErrorCode::INTERNAL_ERROR), std::string("writeChain() error"))); return folly::makeUnexpected(LocalErrorCode::INTERNAL_ERROR); } return folly::unit; } void QuicTransportBase::notifyStartWritingFromAppRateLimited() { if (getSocketObserverContainer() && getSocketObserverContainer() ->hasObserversForEvent< SocketObserverInterface::Events::appRateLimitedEvents>()) { getSocketObserverContainer() ->invokeInterfaceMethod< SocketObserverInterface::Events::appRateLimitedEvents>( [event = SocketObserverInterface::AppLimitedEvent::Builder() .setOutstandingPackets(conn_->outstandings.packets) .setWriteCount(conn_->writeCount) .setLastPacketSentTime( conn_->lossState.maybeLastPacketSentTime) .setCwndInBytes( conn_->congestionController ? folly::Optional( conn_->congestionController ->getCongestionWindow()) : folly::none) .setWritableBytes( conn_->congestionController ? folly::Optional( conn_->congestionController ->getWritableBytes()) : folly::none) .build()](auto observer, auto observed) { observer->startWritingFromAppLimited(observed, event); }); } } void QuicTransportBase::notifyPacketsWritten( uint64_t numPacketsWritten, uint64_t numAckElicitingPacketsWritten, uint64_t numBytesWritten) { if (getSocketObserverContainer() && getSocketObserverContainer() ->hasObserversForEvent< SocketObserverInterface::Events::packetsWrittenEvents>()) { getSocketObserverContainer() ->invokeInterfaceMethod< SocketObserverInterface::Events::packetsWrittenEvents>( [event = SocketObserverInterface::PacketsWrittenEvent::Builder() .setOutstandingPackets(conn_->outstandings.packets) .setWriteCount(conn_->writeCount) .setLastPacketSentTime( conn_->lossState.maybeLastPacketSentTime) .setCwndInBytes( conn_->congestionController ? folly::Optional( conn_->congestionController ->getCongestionWindow()) : folly::none) .setWritableBytes( conn_->congestionController ? folly::Optional( conn_->congestionController ->getWritableBytes()) : folly::none) .setNumPacketsWritten(numPacketsWritten) .setNumAckElicitingPacketsWritten( numAckElicitingPacketsWritten) .setNumBytesWritten(numBytesWritten) .build()](auto observer, auto observed) { observer->packetsWritten(observed, event); }); } } void QuicTransportBase::notifyAppRateLimited() { if (getSocketObserverContainer() && getSocketObserverContainer() ->hasObserversForEvent< SocketObserverInterface::Events::appRateLimitedEvents>()) { getSocketObserverContainer() ->invokeInterfaceMethod< SocketObserverInterface::Events::appRateLimitedEvents>( [event = SocketObserverInterface::AppLimitedEvent::Builder() .setOutstandingPackets(conn_->outstandings.packets) .setWriteCount(conn_->writeCount) .setLastPacketSentTime( conn_->lossState.maybeLastPacketSentTime) .setCwndInBytes( conn_->congestionController ? folly::Optional( conn_->congestionController ->getCongestionWindow()) : folly::none) .setWritableBytes( conn_->congestionController ? folly::Optional( conn_->congestionController ->getWritableBytes()) : folly::none) .build()](auto observer, auto observed) { observer->appRateLimited(observed, event); }); } } void QuicTransportBase::setCmsgs(const folly::SocketCmsgMap& options) { socket_->setCmsgs(options); } void QuicTransportBase::appendCmsgs(const folly::SocketCmsgMap& options) { socket_->appendCmsgs(options); } void QuicTransportBase::setBackgroundModeParameters( PriorityLevel maxBackgroundPriority, float backgroundUtilizationFactor) { backgroundPriorityThreshold_.assign(maxBackgroundPriority); backgroundUtilizationFactor_.assign(backgroundUtilizationFactor); conn_->streamManager->setPriorityChangesObserver(this); onStreamPrioritiesChange(); } void QuicTransportBase::clearBackgroundModeParameters() { backgroundPriorityThreshold_.clear(); backgroundUtilizationFactor_.clear(); conn_->streamManager->resetPriorityChangesObserver(); onStreamPrioritiesChange(); } // If backgroundPriorityThreshold_ and backgroundUtilizationFactor_ are set // and all streams have equal or lower priority than the threshold (value >= // threshold), set the connection's congestion controller to use background // mode with the set utilization factor. In all other cases, turn off the // congestion controller's background mode. void QuicTransportBase::onStreamPrioritiesChange() { if (conn_->congestionController == nullptr) { return; } if (!backgroundPriorityThreshold_.hasValue() || !backgroundUtilizationFactor_.hasValue()) { conn_->congestionController->setBandwidthUtilizationFactor(1.0); return; } bool allStreamsBackground = conn_->streamManager->getHighestPriorityLevel() >= backgroundPriorityThreshold_.value(); float targetUtilization = allStreamsBackground ? backgroundUtilizationFactor_.value() : 1.0f; VLOG(10) << fmt::format( "Updating transport background mode. Highest Priority={} Threshold={} TargetUtilization={}", conn_->streamManager->getHighestPriorityLevel(), backgroundPriorityThreshold_.value(), targetUtilization); conn_->congestionController->setBandwidthUtilizationFactor(targetUtilization); } bool QuicTransportBase::checkCustomRetransmissionProfilesEnabled() const { return quic::checkCustomRetransmissionProfilesEnabled(*conn_); } folly::Expected QuicTransportBase::setStreamGroupRetransmissionPolicy( StreamGroupId groupId, std::optional policy) noexcept { // Reset the policy to default one. if (policy == std::nullopt) { conn_->retransmissionPolicies.erase(groupId); return folly::unit; } if (!checkCustomRetransmissionProfilesEnabled()) { return folly::makeUnexpected(LocalErrorCode::INVALID_OPERATION); } if (conn_->retransmissionPolicies.size() >= conn_->transportSettings.advertisedMaxStreamGroups) { return folly::makeUnexpected(LocalErrorCode::RTX_POLICIES_LIMIT_EXCEEDED); } conn_->retransmissionPolicies.emplace(groupId, *policy); return folly::unit; } void QuicTransportBase::updatePacketProcessorsPrewriteRequests() { folly::SocketCmsgMap cmsgs; for (const auto& pp : conn_->packetProcessors) { // In case of overlapping cmsg keys, the priority is given to // that were added to the QuicSocket first. auto writeRequest = pp->prewrite(); if (writeRequest && writeRequest->cmsgs) { cmsgs.insert(writeRequest->cmsgs->begin(), writeRequest->cmsgs->end()); } } if (!cmsgs.empty()) { conn_->socketCmsgsState.additionalCmsgs = cmsgs; } else { conn_->socketCmsgsState.additionalCmsgs.reset(); } conn_->socketCmsgsState.targetWriteCount = conn_->writeCount; } folly::Optional QuicTransportBase::getAdditionalCmsgsForAsyncUDPSocket() { if (conn_->socketCmsgsState.additionalCmsgs) { // This callback should be happening for the target write DCHECK(conn_->writeCount == conn_->socketCmsgsState.targetWriteCount); return conn_->socketCmsgsState.additionalCmsgs; } return folly::none; } } // namespace quic