/* * Copyright (c) Facebook, Inc. and its 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 namespace { void addQuicSimpleFrameToEvent( quic::QLogPacketEvent* event, const quic::QuicSimpleFrame& simpleFrame) { folly::variant_match( simpleFrame, [&](const quic::StopSendingFrame& frame) { event->frames.push_back(std::make_unique( frame.streamId, frame.errorCode)); }, [&](const quic::MinStreamDataFrame& frame) { event->frames.push_back(std::make_unique( frame.streamId, frame.maximumData, frame.minimumStreamOffset)); }, [&](const quic::ExpiredStreamDataFrame& frame) { event->frames.push_back( std::make_unique( frame.streamId, frame.minimumStreamOffset)); }, [&](const quic::PathChallengeFrame& frame) { event->frames.push_back( std::make_unique(frame.pathData)); }, [&](const quic::PathResponseFrame& frame) { event->frames.push_back( std::make_unique(frame.pathData)); }, [&](const quic::NewConnectionIdFrame& frame) { event->frames.push_back(std::make_unique( frame.sequenceNumber, frame.token)); }, [&](const quic::MaxStreamsFrame& frame) { event->frames.push_back(std::make_unique( frame.maxStreams, frame.isForBidirectional)); }, [&](const quic::RetireConnectionIdFrame& frame) { event->frames.push_back( std::make_unique( frame.sequenceNumber)); }); } } // namespace namespace quic { std::unique_ptr QLogger::createPacketEvent( const RegularQuicPacket& regularPacket, uint64_t packetSize) { auto event = std::make_unique(); event->refTime = std::chrono::duration_cast( std::chrono::steady_clock::now() - refTimePoint); event->packetSize = packetSize; event->eventType = QLogEventType::PacketReceived; const ShortHeader* shortHeader = regularPacket.header.asShort(); if (shortHeader) { event->packetType = kShortHeaderPacketType.toString(); } else { event->packetType = toString(regularPacket.header.asLong()->getHeaderType()); } if (event->packetType != toString(LongHeader::Types::Retry)) { // A Retry packet does not include a packet number. event->packetNum = regularPacket.header.getPacketSequenceNum(); } uint64_t numPaddingFrames = 0; // looping through the packet to store logs created from frames in the packet for (const auto& quicFrame : regularPacket.frames) { switch (quicFrame.type()) { case QuicFrame::Type::PaddingFrame: { ++numPaddingFrames; break; } case QuicFrame::Type::RstStreamFrame: { const auto& frame = *quicFrame.asRstStreamFrame(); event->frames.push_back(std::make_unique( frame.streamId, frame.errorCode, frame.offset)); break; } case QuicFrame::Type::ConnectionCloseFrame: { const auto& frame = *quicFrame.asConnectionCloseFrame(); event->frames.push_back(std::make_unique( frame.errorCode, frame.reasonPhrase, frame.closingFrameType)); break; } case QuicFrame::Type::ApplicationCloseFrame: { const auto& frame = *quicFrame.asApplicationCloseFrame(); event->frames.push_back(std::make_unique( frame.errorCode, frame.reasonPhrase)); break; } case QuicFrame::Type::MaxDataFrame: { const auto& frame = *quicFrame.asMaxDataFrame(); event->frames.push_back( std::make_unique(frame.maximumData)); break; } case QuicFrame::Type::MaxStreamDataFrame: { const auto& frame = *quicFrame.asMaxStreamDataFrame(); event->frames.push_back(std::make_unique( frame.streamId, frame.maximumData)); break; } case QuicFrame::Type::PingFrame: { event->frames.push_back(std::make_unique()); break; } case QuicFrame::Type::DataBlockedFrame: { const auto& frame = *quicFrame.asDataBlockedFrame(); event->frames.push_back( std::make_unique(frame.dataLimit)); break; } case QuicFrame::Type::StreamDataBlockedFrame: { const auto& frame = *quicFrame.asStreamDataBlockedFrame(); event->frames.push_back(std::make_unique( frame.streamId, frame.dataLimit)); break; } case QuicFrame::Type::StreamsBlockedFrame: { const auto& frame = *quicFrame.asStreamsBlockedFrame(); event->frames.push_back(std::make_unique( frame.streamLimit, frame.isForBidirectional)); break; } case QuicFrame::Type::ReadAckFrame: { const auto& frame = *quicFrame.asReadAckFrame(); event->frames.push_back( std::make_unique(frame.ackBlocks, frame.ackDelay)); break; } case QuicFrame::Type::ReadStreamFrame: { const auto& frame = *quicFrame.asReadStreamFrame(); event->frames.push_back(std::make_unique( frame.streamId, frame.offset, frame.data->length(), frame.fin)); break; } case QuicFrame::Type::ReadCryptoFrame: { const auto& frame = *quicFrame.asReadCryptoFrame(); event->frames.push_back(std::make_unique( frame.offset, frame.data->length())); break; } case QuicFrame::Type::ReadNewTokenFrame: { event->frames.push_back(std::make_unique()); break; } case QuicFrame::Type::QuicSimpleFrame: { const auto& simpleFrame = *quicFrame.asQuicSimpleFrame(); addQuicSimpleFrameToEvent(event.get(), simpleFrame); break; } case QuicFrame::Type::NoopFrame: { break; } } } if (numPaddingFrames > 0) { event->frames.push_back( std::make_unique(numPaddingFrames)); } return event; } std::unique_ptr QLogger::createPacketEvent( const RegularQuicWritePacket& writePacket, uint64_t packetSize) { auto event = std::make_unique(); event->refTime = std::chrono::duration_cast( std::chrono::steady_clock::now() - refTimePoint); event->packetNum = writePacket.header.getPacketSequenceNum(); event->packetSize = packetSize; event->eventType = QLogEventType::PacketSent; const ShortHeader* shortHeader = writePacket.header.asShort(); if (shortHeader) { event->packetType = kShortHeaderPacketType.toString(); } else { event->packetType = toString(writePacket.header.asLong()->getHeaderType()); } uint64_t numPaddingFrames = 0; // looping through the packet to store logs created from frames in the packet for (const auto& quicFrame : writePacket.frames) { folly::variant_match( quicFrame, [&](const PaddingFrame& /* unused */) { ++numPaddingFrames; }, [&](const RstStreamFrame& frame) { event->frames.push_back(std::make_unique( frame.streamId, frame.errorCode, frame.offset)); }, [&](const ConnectionCloseFrame& frame) { event->frames.push_back(std::make_unique( frame.errorCode, frame.reasonPhrase, frame.closingFrameType)); }, [&](const ApplicationCloseFrame& frame) { event->frames.push_back(std::make_unique( frame.errorCode, frame.reasonPhrase)); }, [&](const MaxDataFrame& frame) { event->frames.push_back( std::make_unique(frame.maximumData)); }, [&](const MaxStreamDataFrame& frame) { event->frames.push_back(std::make_unique( frame.streamId, frame.maximumData)); }, [&](const StreamsBlockedFrame& frame) { event->frames.push_back(std::make_unique( frame.streamLimit, frame.isForBidirectional)); }, [&](const PingFrame& /* unused */) { event->frames.push_back(std::make_unique()); }, [&](const DataBlockedFrame& frame) { event->frames.push_back( std::make_unique(frame.dataLimit)); }, [&](const StreamDataBlockedFrame& frame) { event->frames.push_back(std::make_unique( frame.streamId, frame.dataLimit)); }, [&](const WriteAckFrame& frame) { event->frames.push_back(std::make_unique( frame.ackBlocks, frame.ackDelay)); }, [&](const WriteStreamFrame& frame) { event->frames.push_back(std::make_unique( frame.streamId, frame.offset, frame.len, frame.fin)); }, [&](const WriteCryptoFrame& frame) { event->frames.push_back( std::make_unique(frame.offset, frame.len)); }, [&](const QuicSimpleFrame& simpleFrame) { addQuicSimpleFrameToEvent(event.get(), simpleFrame); }, [&](const auto& /* unused */) { // Ignore other frames. }); } if (numPaddingFrames > 0) { event->frames.push_back( std::make_unique(numPaddingFrames)); } return event; } std::unique_ptr QLogger::createPacketEvent( const VersionNegotiationPacket& versionPacket, uint64_t packetSize, bool isPacketRecvd) { auto event = std::make_unique(); event->refTime = std::chrono::duration_cast( std::chrono::steady_clock::now() - refTimePoint); event->packetSize = packetSize; event->eventType = isPacketRecvd ? QLogEventType::PacketReceived : QLogEventType::PacketSent; event->packetType = kVersionNegotiationPacketType; event->versionLog = std::make_unique( VersionNegotiationLog(versionPacket.versions)); return event; } std::string getFlowControlEvent(int offset) { return "flow control event, new offset: " + folly::to(offset); }; std::string getRxStreamWU(StreamId streamId, PacketNum packetNum, uint64_t maximumData) { return "rx stream, streamId: " + folly::to(streamId) + ", packetNum: " + folly::to(packetNum) + ", maximumData: " + folly::to(maximumData); }; std::string getRxConnWU(PacketNum packetNum, uint64_t maximumData) { return "rx, packetNum: " + folly::to(packetNum) + ", maximumData: " + folly::to(maximumData); }; std::string getPeerClose(const std::string& peerCloseReason) { return "error message: " + peerCloseReason; }; std::string getFlowControlWindowAvailable(uint64_t windowAvailable) { return "on flow control, window available: " + folly::to(windowAvailable); }; std::string getClosingStream(const std::string& streamId) { return "closing stream, stream id: " + streamId; }; } // namespace quic