Skip to content

Commit

Permalink
Lowercase qlog strings.
Browse files Browse the repository at this point in the history
Summary: In the spec these are now lowercase.

Reviewed By: avasylev

Differential Revision: D22104880

fbshipit-source-id: adc9bbcd7bd9e7babb1946648d2867ec7dc9336b
  • Loading branch information
mjoras authored and facebook-github-bot committed Jul 14, 2020
1 parent aedfaf2 commit 015ff4a
Show file tree
Hide file tree
Showing 8 changed files with 257 additions and 176 deletions.
35 changes: 18 additions & 17 deletions quic/api/test/QuicTransportFunctionsTest.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ TEST_F(QuicTransportFunctionsTest, TestUpdateConnection) {
for (int i = 0; i < 2; ++i) {
auto p1 = std::move(qLogger->logs[indices[i]]);
auto event = dynamic_cast<QLogPacketEvent*>(p1.get());
EXPECT_EQ(event->packetType, toString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetType, toQlogString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetSize, getEncodedSize(packet));
EXPECT_EQ(event->eventType, QLogEventType::PacketSent);

Expand Down Expand Up @@ -408,9 +408,9 @@ TEST_F(QuicTransportFunctionsTest, TestUpdateConnectionPacketSorting) {
auto event2 = dynamic_cast<QLogPacketEvent*>(l2.get());
auto event3 = dynamic_cast<QLogPacketEvent*>(l3.get());

EXPECT_EQ(event1->packetType, toString(LongHeader::Types::Handshake));
EXPECT_EQ(event2->packetType, toString(LongHeader::Types::Initial));
EXPECT_EQ(event3->packetType, toString(LongHeader::Types::ZeroRtt));
EXPECT_EQ(event1->packetType, toQlogString(LongHeader::Types::Handshake));
EXPECT_EQ(event2->packetType, toQlogString(LongHeader::Types::Initial));
EXPECT_EQ(event3->packetType, toQlogString(LongHeader::Types::ZeroRtt));

EXPECT_EQ(3, conn->outstandings.packets.size());
auto& firstHeader = conn->outstandings.packets.front().packet.header;
Expand Down Expand Up @@ -450,7 +450,7 @@ TEST_F(QuicTransportFunctionsTest, TestUpdateConnectionFinOnly) {
auto tmp = std::move(qLogger->logs[indices[0]]);

auto event = dynamic_cast<QLogPacketEvent*>(tmp.get());
EXPECT_EQ(event->packetType, toString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetType, toQlogString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetSize, getEncodedSize(packet));
EXPECT_EQ(event->eventType, QLogEventType::PacketSent);

Expand Down Expand Up @@ -495,7 +495,7 @@ TEST_F(QuicTransportFunctionsTest, TestUpdateConnectionAllBytesExceptFin) {
auto tmp = std::move(qLogger->logs[indices[0]]);
auto event = dynamic_cast<QLogPacketEvent*>(tmp.get());

EXPECT_EQ(event->packetType, toString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetType, toQlogString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetSize, getEncodedSize(packet));
EXPECT_EQ(event->eventType, QLogEventType::PacketSent);

Expand Down Expand Up @@ -538,7 +538,7 @@ TEST_F(QuicTransportFunctionsTest, TestUpdateConnectionEmptyAckWriteResult) {
EXPECT_EQ(indices.size(), 1);
auto tmp = std::move(qLogger->logs[indices[0]]);
auto event = dynamic_cast<QLogPacketEvent*>(tmp.get());
EXPECT_EQ(event->packetType, toString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetType, toQlogString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetSize, getEncodedSize(packet));
EXPECT_EQ(event->eventType, QLogEventType::PacketSent);

Expand Down Expand Up @@ -591,7 +591,7 @@ TEST_F(QuicTransportFunctionsTest, TestUpdateConnectionPureAckCounter) {
for (int i = 0; i < 2; ++i) {
auto tmp = std::move(qLogger->logs[indices[i]]);
auto event = dynamic_cast<QLogPacketEvent*>(tmp.get());
EXPECT_EQ(event->packetType, toString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetType, toQlogString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetSize, getEncodedSize(packet));
EXPECT_EQ(event->frames.size(), 1);
}
Expand Down Expand Up @@ -621,7 +621,7 @@ TEST_F(QuicTransportFunctionsTest, TestPaddingPureAckPacketIsStillPureAck) {
auto tmp = std::move(qLogger->logs[indices[0]]);

auto event = dynamic_cast<QLogPacketEvent*>(tmp.get());
EXPECT_EQ(event->packetType, toString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetType, toQlogString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetSize, getEncodedSize(packet));
EXPECT_EQ(event->eventType, QLogEventType::PacketSent);
EXPECT_EQ(event->frames.size(), 2);
Expand Down Expand Up @@ -769,8 +769,8 @@ TEST_F(QuicTransportFunctionsTest, TestUpdateConnectionHandshakeCounter) {
getQLogEventIndices(QLogEventType::PacketSent, qLogger);
EXPECT_EQ(indices.size(), 2);
std::vector<std::string> packetTypes = {
toString(LongHeader::Types::Handshake),
toString(LongHeader::Types::ZeroRtt)};
std::string(toQlogString(LongHeader::Types::Handshake)),
std::string(toQlogString(LongHeader::Types::ZeroRtt))};
for (int i = 0; i < 2; ++i) {
auto tmp = std::move(qLogger->logs[indices[i]]);
auto event = dynamic_cast<QLogPacketEvent*>(tmp.get());
Expand Down Expand Up @@ -838,8 +838,9 @@ TEST_F(QuicTransportFunctionsTest, TestUpdateConnectionForOneRttCryptoData) {
std::vector<int> indices =
getQLogEventIndices(QLogEventType::PacketSent, qLogger);
EXPECT_EQ(indices.size(), 2);
std::vector<std::string> packetTypes = {kShortHeaderPacketType.str(),
toString(LongHeader::Types::ZeroRtt)};
std::vector<std::string> packetTypes = {
kShortHeaderPacketType.str(),
std::string(toQlogString(LongHeader::Types::ZeroRtt))};
for (int i = 0; i < 2; ++i) {
auto tmp = std::move(qLogger->logs[indices[i]]);
auto event = dynamic_cast<QLogPacketEvent*>(tmp.get());
Expand Down Expand Up @@ -895,7 +896,7 @@ TEST_F(QuicTransportFunctionsTest, TestUpdateConnectionWithPureAck) {
EXPECT_EQ(indices.size(), 1);
auto tmp = std::move(qLogger->logs[indices[0]]);
auto event = dynamic_cast<QLogPacketEvent*>(tmp.get());
EXPECT_EQ(event->packetType, toString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetType, toQlogString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetSize, getEncodedSize(packet));
EXPECT_EQ(event->eventType, QLogEventType::PacketSent);
// verify QLogger contains correct frame information
Expand Down Expand Up @@ -932,7 +933,7 @@ TEST_F(QuicTransportFunctionsTest, TestUpdateConnectionWithBytesStats) {
auto tmp = std::move(qLogger->logs[indices[0]]);
auto event = dynamic_cast<QLogPacketEvent*>(tmp.get());

EXPECT_EQ(event->packetType, toString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetType, toQlogString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetSize, 555);
EXPECT_EQ(event->eventType, QLogEventType::PacketSent);

Expand Down Expand Up @@ -1037,7 +1038,7 @@ TEST_F(QuicTransportFunctionsTest, TestUpdateConnectionStreamWindowUpdate) {
auto tmp = std::move(qLogger->logs[indices[0]]);
auto event = dynamic_cast<QLogPacketEvent*>(tmp.get());

EXPECT_EQ(event->packetType, toString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetType, toQlogString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetSize, getEncodedSize(packet));
EXPECT_EQ(event->eventType, QLogEventType::PacketSent);

Expand Down Expand Up @@ -1072,7 +1073,7 @@ TEST_F(QuicTransportFunctionsTest, TestUpdateConnectionConnWindowUpdate) {
auto tmp = std::move(qLogger->logs[indices[0]]);
auto event = dynamic_cast<QLogPacketEvent*>(tmp.get());

EXPECT_EQ(event->packetType, toString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetType, toQlogString(LongHeader::Types::Handshake));
EXPECT_EQ(event->packetSize, getEncodedSize(packet));
EXPECT_EQ(event->eventType, QLogEventType::PacketSent);
// verify QLogger contains correct frame information
Expand Down
7 changes: 4 additions & 3 deletions quic/logging/BaseQLogger.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ std::unique_ptr<QLogPacketEvent> BaseQLogger::createPacketEvent(
event->packetType = kShortHeaderPacketType.toString();
} else {
event->packetType =
toString(regularPacket.header.asLong()->getHeaderType());
toQlogString(regularPacket.header.asLong()->getHeaderType()).str();
}
if (event->packetType != toString(LongHeader::Types::Retry)) {
// A Retry packet does not include a packet number.
Expand Down Expand Up @@ -196,7 +196,8 @@ std::unique_ptr<QLogPacketEvent> BaseQLogger::createPacketEvent(
if (shortHeader) {
event->packetType = kShortHeaderPacketType.toString();
} else {
event->packetType = toString(writePacket.header.asLong()->getHeaderType());
event->packetType =
toQlogString(writePacket.header.asLong()->getHeaderType()).str();
}

uint64_t numPaddingFrames = 0;
Expand Down Expand Up @@ -310,7 +311,7 @@ std::unique_ptr<QLogRetryEvent> BaseQLogger::createPacketEvent(
event->tokenSize = retryPacket.header.getToken().size();
event->eventType =
isPacketRecvd ? QLogEventType::PacketReceived : QLogEventType::PacketSent;
event->packetType = toString(retryPacket.header.getHeaderType());
event->packetType = toQlogString(retryPacket.header.getHeaderType()).str();
return event;
}

Expand Down
2 changes: 1 addition & 1 deletion quic/logging/FileQLogger.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ folly::dynamic FileQLogger::toDynamicBase() const {

dynamicTrace["events"] = folly::dynamic::array();
dynamicTrace["event_fields"] =
folly::dynamic::array("relative_time", "CATEGORY", "EVENT_TYPE", "DATA");
folly::dynamic::array("relative_time", "category", "event", "data");

dynamicObj["traces"].push_back(dynamicTrace);

Expand Down
77 changes: 77 additions & 0 deletions quic/logging/QLoggerConstants.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,81 @@ folly::StringPiece vantagePointString(VantagePoint vantagePoint) noexcept {
}
folly::assume_unreachable();
}

folly::StringPiece toQlogString(FrameType frame) {
switch (frame) {
case FrameType::PADDING:
return "padding";
case FrameType::PING:
return "ping";
case FrameType::ACK:
return "ack";
case FrameType::ACK_ECN:
return "ack_ecn";
case FrameType::RST_STREAM:
return "rst_stream";
case FrameType::STOP_SENDING:
return "stop_sending";
case FrameType::CRYPTO_FRAME:
return "crypto_frame";
case FrameType::NEW_TOKEN:
return "new_token";
case FrameType::STREAM:
case FrameType::STREAM_FIN:
case FrameType::STREAM_LEN:
case FrameType::STREAM_LEN_FIN:
case FrameType::STREAM_OFF:
case FrameType::STREAM_OFF_FIN:
case FrameType::STREAM_OFF_LEN:
case FrameType::STREAM_OFF_LEN_FIN:
return "stream";
case FrameType::MAX_DATA:
return "max_data";
case FrameType::MAX_STREAM_DATA:
return "max_stream_data";
case FrameType::MAX_STREAMS_BIDI:
case FrameType::MAX_STREAMS_UNI:
return "max_streams";
case FrameType::DATA_BLOCKED:
return "data_blocked";
case FrameType::STREAM_DATA_BLOCKED:
return "stream_data_blocked";
case FrameType::STREAMS_BLOCKED_BIDI:
case FrameType::STREAMS_BLOCKED_UNI:
return "streams_blocked";
case FrameType::NEW_CONNECTION_ID:
return "new_connection_id";
case FrameType::RETIRE_CONNECTION_ID:
return "retire_connection_id";
case FrameType::PATH_CHALLENGE:
return "path_challenge";
case FrameType::PATH_RESPONSE:
return "path_response";
case FrameType::CONNECTION_CLOSE:
case FrameType::CONNECTION_CLOSE_APP_ERR:
return "connection_close";
case FrameType::MIN_STREAM_DATA:
return "min_stream_data";
case FrameType::EXPIRED_STREAM_DATA:
return "expired_stream_data";
case FrameType::HANDSHAKE_DONE:
return "handshake_done";
}
folly::assume_unreachable();
}

folly::StringPiece toQlogString(LongHeader::Types type) {
switch (type) {
case LongHeader::Types::Initial:
return "initial";
case LongHeader::Types::Retry:
return "RETRY";
case LongHeader::Types::Handshake:
return "handshake";
case LongHeader::Types::ZeroRtt:
return "0RTT";
}
folly::assume_unreachable();
}

} // namespace quic
7 changes: 6 additions & 1 deletion quic/logging/QLoggerConstants.h
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@
#pragma once

#include <folly/String.h>
#include <quic/codec/Types.h>
#include "quic/QuicConstants.h"

namespace quic {
constexpr folly::StringPiece kShortHeaderPacketType = "1RTT";
constexpr auto kVersionNegotiationPacketType = "VersionNegotiation";
constexpr auto kVersionNegotiationPacketType = "version_negotiation";
constexpr auto kHTTP3ProtocolType = "QUIC_HTTP3";
constexpr auto kNoError = "no error";
constexpr auto kGracefulExit = "graceful exit";
Expand Down Expand Up @@ -88,4 +89,8 @@ using VantagePoint = QuicNodeType;

folly::StringPiece vantagePointString(VantagePoint vantagePoint) noexcept;

folly::StringPiece toQlogString(FrameType frame);

folly::StringPiece toQlogString(LongHeader::Types type);

} // namespace quic
Loading

0 comments on commit 015ff4a

Please sign in to comment.