gfe-relnote: Convert IETF RESET_STREAM error codes to and from QuicRstStreamErrorCode. Protected by gfe2_reloadable_flag_quic_enable_version_draft_25_v3 and gfe2_reloadable_flag_quic_enable_version_draft_27.
IETF HTTP/3 error codes are different from Google QUIC's error codes, so some
information will be lost with IETF QUIC when translating QuicRstStreamErrorCode
to the wire and then back. Only the main category (no error, cancelled,
protocol error) is preserved.
The advantage of keeping QuicRstStreamErrorCode and adding new values for IETF
error codes is that existing APIs, most notably QuicStream::error_code(), can be
kept without need for modification. QuicStream::error_code() is almost exclusively
checked for QUIC_STREAM_NO_ERROR, QUIC_STREAM_CONNECTION_ERROR, and QUIC_STREAM_CANCELLED, the semantics of which are retained.
PiperOrigin-RevId: 306264118
Change-Id: I24f0aa810052ae42820623d5a55dfb9610db0a3c
diff --git a/quic/core/frames/quic_rst_stream_frame.cc b/quic/core/frames/quic_rst_stream_frame.cc
index d9e14b7..b5730a5 100644
--- a/quic/core/frames/quic_rst_stream_frame.cc
+++ b/quic/core/frames/quic_rst_stream_frame.cc
@@ -20,8 +20,7 @@
: control_frame_id(control_frame_id),
stream_id(stream_id),
error_code(error_code),
- // TODO(b/124216424): Translate QuicRstStreamErrorCode to IETF error code.
- ietf_error_code(error_code),
+ ietf_error_code(RstStreamErrorCodeToIetfResetStreamErrorCode(error_code)),
byte_offset(bytes_written) {}
std::ostream& operator<<(std::ostream& os,
diff --git a/quic/core/frames/quic_rst_stream_frame.h b/quic/core/frames/quic_rst_stream_frame.h
index 6239123..e15ae1d 100644
--- a/quic/core/frames/quic_rst_stream_frame.h
+++ b/quic/core/frames/quic_rst_stream_frame.h
@@ -29,11 +29,14 @@
QuicStreamId stream_id;
- // Used for Google QUIC only.
- // TODO(b/124216424): Consider using meaningful values when using IETF QUIC.
+ // When using Google QUIC: the RST_STREAM error code on the wire.
+ // When using IETF QUIC: for an outgoing RESET_STREAM frame, the error code
+ // generated by the application that determines |ietf_error_code| to be sent
+ // on the wire; for an incoming RESET_STREAM frame, the error code inferred
+ // from the |ietf_error_code| received on the wire.
QuicRstStreamErrorCode error_code;
- // Used for IETF QUIC only.
+ // Application error code of RESET_STREAM frame. Used for IETF QUIC only.
uint64_t ietf_error_code;
// Used to update flow control windows. On termination of a stream, both
diff --git a/quic/core/quic_error_codes.cc b/quic/core/quic_error_codes.cc
index ea50e0b..a559feb 100644
--- a/quic/core/quic_error_codes.cc
+++ b/quic/core/quic_error_codes.cc
@@ -16,15 +16,14 @@
const char* QuicRstStreamErrorCodeToString(QuicRstStreamErrorCode error) {
switch (error) {
RETURN_STRING_LITERAL(QUIC_STREAM_NO_ERROR);
- RETURN_STRING_LITERAL(QUIC_STREAM_CONNECTION_ERROR);
RETURN_STRING_LITERAL(QUIC_ERROR_PROCESSING_STREAM);
RETURN_STRING_LITERAL(QUIC_MULTIPLE_TERMINATION_OFFSETS);
RETURN_STRING_LITERAL(QUIC_BAD_APPLICATION_PAYLOAD);
+ RETURN_STRING_LITERAL(QUIC_STREAM_CONNECTION_ERROR);
RETURN_STRING_LITERAL(QUIC_STREAM_PEER_GOING_AWAY);
RETURN_STRING_LITERAL(QUIC_STREAM_CANCELLED);
RETURN_STRING_LITERAL(QUIC_RST_ACKNOWLEDGEMENT);
RETURN_STRING_LITERAL(QUIC_REFUSED_STREAM);
- RETURN_STRING_LITERAL(QUIC_STREAM_LAST_ERROR);
RETURN_STRING_LITERAL(QUIC_INVALID_PROMISE_URL);
RETURN_STRING_LITERAL(QUIC_UNAUTHORIZED_PROMISE_URL);
RETURN_STRING_LITERAL(QUIC_DUPLICATE_PROMISE_URL);
@@ -32,8 +31,27 @@
RETURN_STRING_LITERAL(QUIC_INVALID_PROMISE_METHOD);
RETURN_STRING_LITERAL(QUIC_PUSH_STREAM_TIMED_OUT);
RETURN_STRING_LITERAL(QUIC_HEADERS_TOO_LARGE);
- RETURN_STRING_LITERAL(QUIC_DATA_AFTER_CLOSE_OFFSET);
RETURN_STRING_LITERAL(QUIC_STREAM_TTL_EXPIRED);
+ RETURN_STRING_LITERAL(QUIC_DATA_AFTER_CLOSE_OFFSET);
+ RETURN_STRING_LITERAL(QUIC_STREAM_GENERAL_PROTOCOL_ERROR);
+ RETURN_STRING_LITERAL(QUIC_STREAM_INTERNAL_ERROR);
+ RETURN_STRING_LITERAL(QUIC_STREAM_STREAM_CREATION_ERROR);
+ RETURN_STRING_LITERAL(QUIC_STREAM_CLOSED_CRITICAL_STREAM);
+ RETURN_STRING_LITERAL(QUIC_STREAM_FRAME_UNEXPECTED);
+ RETURN_STRING_LITERAL(QUIC_STREAM_FRAME_ERROR);
+ RETURN_STRING_LITERAL(QUIC_STREAM_EXCESSIVE_LOAD);
+ RETURN_STRING_LITERAL(QUIC_STREAM_ID_ERROR);
+ RETURN_STRING_LITERAL(QUIC_STREAM_SETTINGS_ERROR);
+ RETURN_STRING_LITERAL(QUIC_STREAM_MISSING_SETTINGS);
+ RETURN_STRING_LITERAL(QUIC_STREAM_REQUEST_REJECTED);
+ RETURN_STRING_LITERAL(QUIC_STREAM_REQUEST_INCOMPLETE);
+ RETURN_STRING_LITERAL(QUIC_STREAM_CONNECT_ERROR);
+ RETURN_STRING_LITERAL(QUIC_STREAM_VERSION_FALLBACK);
+ RETURN_STRING_LITERAL(QUIC_STREAM_DECOMPRESSION_FAILED);
+ RETURN_STRING_LITERAL(QUIC_STREAM_ENCODER_STREAM_ERROR);
+ RETURN_STRING_LITERAL(QUIC_STREAM_DECODER_STREAM_ERROR);
+ RETURN_STRING_LITERAL(QUIC_STREAM_UNKNOWN_APPLICATION_ERRROR_CODE);
+ RETURN_STRING_LITERAL(QUIC_STREAM_LAST_ERROR);
}
// Return a default value so that we return this when |error| doesn't match
// any of the QuicRstStreamErrorCodes. This can happen when the RstStream
@@ -578,6 +596,139 @@
return {true, static_cast<uint64_t>(INTERNAL_ERROR)};
}
+// Convert a QuicRstStreamErrorCode to an application error code to be used in
+// an IETF QUIC RESET_STREAM frame
+uint64_t RstStreamErrorCodeToIetfResetStreamErrorCode(
+ QuicRstStreamErrorCode rst_stream_error_code) {
+ switch (rst_stream_error_code) {
+ case QUIC_STREAM_NO_ERROR:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::NO_ERROR);
+ case QUIC_ERROR_PROCESSING_STREAM:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::GENERAL_PROTOCOL_ERROR);
+ case QUIC_MULTIPLE_TERMINATION_OFFSETS:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::GENERAL_PROTOCOL_ERROR);
+ case QUIC_BAD_APPLICATION_PAYLOAD:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::GENERAL_PROTOCOL_ERROR);
+ case QUIC_STREAM_CONNECTION_ERROR:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::INTERNAL_ERROR);
+ case QUIC_STREAM_PEER_GOING_AWAY:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::GENERAL_PROTOCOL_ERROR);
+ case QUIC_STREAM_CANCELLED:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::REQUEST_CANCELLED);
+ case QUIC_RST_ACKNOWLEDGEMENT:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::NO_ERROR);
+ case QUIC_REFUSED_STREAM:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::ID_ERROR);
+ case QUIC_INVALID_PROMISE_URL:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::STREAM_CREATION_ERROR);
+ case QUIC_UNAUTHORIZED_PROMISE_URL:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::STREAM_CREATION_ERROR);
+ case QUIC_DUPLICATE_PROMISE_URL:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::STREAM_CREATION_ERROR);
+ case QUIC_PROMISE_VARY_MISMATCH:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::REQUEST_CANCELLED);
+ case QUIC_INVALID_PROMISE_METHOD:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::STREAM_CREATION_ERROR);
+ case QUIC_PUSH_STREAM_TIMED_OUT:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::REQUEST_CANCELLED);
+ case QUIC_HEADERS_TOO_LARGE:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::EXCESSIVE_LOAD);
+ case QUIC_STREAM_TTL_EXPIRED:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::REQUEST_CANCELLED);
+ case QUIC_DATA_AFTER_CLOSE_OFFSET:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::GENERAL_PROTOCOL_ERROR);
+ case QUIC_STREAM_GENERAL_PROTOCOL_ERROR:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::GENERAL_PROTOCOL_ERROR);
+ case QUIC_STREAM_INTERNAL_ERROR:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::INTERNAL_ERROR);
+ case QUIC_STREAM_STREAM_CREATION_ERROR:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::STREAM_CREATION_ERROR);
+ case QUIC_STREAM_CLOSED_CRITICAL_STREAM:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::CLOSED_CRITICAL_STREAM);
+ case QUIC_STREAM_FRAME_UNEXPECTED:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::FRAME_UNEXPECTED);
+ case QUIC_STREAM_FRAME_ERROR:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::FRAME_ERROR);
+ case QUIC_STREAM_EXCESSIVE_LOAD:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::EXCESSIVE_LOAD);
+ case QUIC_STREAM_ID_ERROR:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::ID_ERROR);
+ case QUIC_STREAM_SETTINGS_ERROR:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::SETTINGS_ERROR);
+ case QUIC_STREAM_MISSING_SETTINGS:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::MISSING_SETTINGS);
+ case QUIC_STREAM_REQUEST_REJECTED:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::REQUEST_REJECTED);
+ case QUIC_STREAM_REQUEST_INCOMPLETE:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::REQUEST_INCOMPLETE);
+ case QUIC_STREAM_CONNECT_ERROR:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::CONNECT_ERROR);
+ case QUIC_STREAM_VERSION_FALLBACK:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::VERSION_FALLBACK);
+ case QUIC_STREAM_DECOMPRESSION_FAILED:
+ return static_cast<uint64_t>(
+ QuicHttpQpackErrorCode::DECOMPRESSION_FAILED);
+ case QUIC_STREAM_ENCODER_STREAM_ERROR:
+ return static_cast<uint64_t>(
+ QuicHttpQpackErrorCode::ENCODER_STREAM_ERROR);
+ case QUIC_STREAM_DECODER_STREAM_ERROR:
+ return static_cast<uint64_t>(
+ QuicHttpQpackErrorCode::DECODER_STREAM_ERROR);
+ case QUIC_STREAM_UNKNOWN_APPLICATION_ERRROR_CODE:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::INTERNAL_ERROR);
+ case QUIC_STREAM_LAST_ERROR:
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::INTERNAL_ERROR);
+ }
+ return static_cast<uint64_t>(QuicHttp3ErrorCode::INTERNAL_ERROR);
+}
+
+// Convert the application error code of an IETF QUIC RESET_STREAM frame
+// to QuicRstStreamErrorCode.
+QuicRstStreamErrorCode IetfResetStreamErrorCodeToRstStreamErrorCode(
+ uint64_t ietf_error_code) {
+ switch (ietf_error_code) {
+ case static_cast<uint64_t>(QuicHttp3ErrorCode::NO_ERROR):
+ return QUIC_STREAM_NO_ERROR;
+ case static_cast<uint64_t>(QuicHttp3ErrorCode::GENERAL_PROTOCOL_ERROR):
+ return QUIC_STREAM_GENERAL_PROTOCOL_ERROR;
+ case static_cast<uint64_t>(QuicHttp3ErrorCode::INTERNAL_ERROR):
+ return QUIC_STREAM_INTERNAL_ERROR;
+ case static_cast<uint64_t>(QuicHttp3ErrorCode::STREAM_CREATION_ERROR):
+ return QUIC_STREAM_STREAM_CREATION_ERROR;
+ case static_cast<uint64_t>(QuicHttp3ErrorCode::CLOSED_CRITICAL_STREAM):
+ return QUIC_STREAM_CLOSED_CRITICAL_STREAM;
+ case static_cast<uint64_t>(QuicHttp3ErrorCode::FRAME_UNEXPECTED):
+ return QUIC_STREAM_FRAME_UNEXPECTED;
+ case static_cast<uint64_t>(QuicHttp3ErrorCode::FRAME_ERROR):
+ return QUIC_STREAM_FRAME_ERROR;
+ case static_cast<uint64_t>(QuicHttp3ErrorCode::EXCESSIVE_LOAD):
+ return QUIC_STREAM_EXCESSIVE_LOAD;
+ case static_cast<uint64_t>(QuicHttp3ErrorCode::ID_ERROR):
+ return QUIC_STREAM_ID_ERROR;
+ case static_cast<uint64_t>(QuicHttp3ErrorCode::SETTINGS_ERROR):
+ return QUIC_STREAM_SETTINGS_ERROR;
+ case static_cast<uint64_t>(QuicHttp3ErrorCode::MISSING_SETTINGS):
+ return QUIC_STREAM_MISSING_SETTINGS;
+ case static_cast<uint64_t>(QuicHttp3ErrorCode::REQUEST_REJECTED):
+ return QUIC_STREAM_REQUEST_REJECTED;
+ case static_cast<uint64_t>(QuicHttp3ErrorCode::REQUEST_CANCELLED):
+ return QUIC_STREAM_CANCELLED;
+ case static_cast<uint64_t>(QuicHttp3ErrorCode::REQUEST_INCOMPLETE):
+ return QUIC_STREAM_REQUEST_INCOMPLETE;
+ case static_cast<uint64_t>(QuicHttp3ErrorCode::CONNECT_ERROR):
+ return QUIC_STREAM_CONNECT_ERROR;
+ case static_cast<uint64_t>(QuicHttp3ErrorCode::VERSION_FALLBACK):
+ return QUIC_STREAM_VERSION_FALLBACK;
+ case static_cast<uint64_t>(QuicHttpQpackErrorCode::DECOMPRESSION_FAILED):
+ return QUIC_STREAM_DECOMPRESSION_FAILED;
+ case static_cast<uint64_t>(QuicHttpQpackErrorCode::ENCODER_STREAM_ERROR):
+ return QUIC_STREAM_ENCODER_STREAM_ERROR;
+ case static_cast<uint64_t>(QuicHttpQpackErrorCode::DECODER_STREAM_ERROR):
+ return QUIC_STREAM_DECODER_STREAM_ERROR;
+ }
+ return QUIC_STREAM_UNKNOWN_APPLICATION_ERRROR_CODE;
+}
+
#undef RETURN_STRING_LITERAL // undef for jumbo builds
} // namespace quic
diff --git a/quic/core/quic_error_codes.h b/quic/core/quic_error_codes.h
index 912c81d..85245c8 100644
--- a/quic/core/quic_error_codes.h
+++ b/quic/core/quic_error_codes.h
@@ -56,6 +56,53 @@
QUIC_STREAM_TTL_EXPIRED,
// The stream received data that goes beyond its close offset.
QUIC_DATA_AFTER_CLOSE_OFFSET,
+ // Peer violated protocol requirements in a way which does not match a more
+ // specific error code, or endpoint declines to use the more specific error
+ // code.
+ QUIC_STREAM_GENERAL_PROTOCOL_ERROR,
+ // An internal error has occurred.
+ QUIC_STREAM_INTERNAL_ERROR,
+ // Peer created a stream that will not be accepted.
+ QUIC_STREAM_STREAM_CREATION_ERROR,
+ // A stream required by the connection was closed or reset.
+ QUIC_STREAM_CLOSED_CRITICAL_STREAM,
+ // A frame was received which was not permitted in the current state or on the
+ // current stream.
+ QUIC_STREAM_FRAME_UNEXPECTED,
+ // A frame that fails to satisfy layout requirements or with an invalid size
+ // was received.
+ QUIC_STREAM_FRAME_ERROR,
+ // Peer exhibits a behavior that might be generating excessive load.
+ QUIC_STREAM_EXCESSIVE_LOAD,
+ // A Stream ID or Push ID was used incorrectly, such as exceeding a limit,
+ // reducing a limit, or being reused.
+ QUIC_STREAM_ID_ERROR,
+ // Error in the payload of a SETTINGS frame.
+ QUIC_STREAM_SETTINGS_ERROR,
+ // No SETTINGS frame was received at the beginning of the control stream.
+ QUIC_STREAM_MISSING_SETTINGS,
+ // A server rejected a request without performing any application processing.
+ QUIC_STREAM_REQUEST_REJECTED,
+ // The client's stream terminated without containing a fully-formed request.
+ QUIC_STREAM_REQUEST_INCOMPLETE,
+ // The connection established in response to a CONNECT request was reset or
+ // abnormally closed.
+ QUIC_STREAM_CONNECT_ERROR,
+ // The requested operation cannot be served over HTTP/3.
+ // The peer should retry over HTTP/1.1.
+ QUIC_STREAM_VERSION_FALLBACK,
+ // The QPACK decoder failed to interpret a header block and is not able to
+ // continue decoding that header block.
+ QUIC_STREAM_DECOMPRESSION_FAILED,
+ // The QPACK decoder failed to interpret an encoder instruction received on
+ // the encoder stream.
+ QUIC_STREAM_ENCODER_STREAM_ERROR,
+ // The QPACK encoder failed to interpret a decoder instruction received on the
+ // decoder stream.
+ QUIC_STREAM_DECODER_STREAM_ERROR,
+ // IETF RESET_FRAME application error code not matching any HTTP/3 or QPACK
+ // error codes.
+ QUIC_STREAM_UNKNOWN_APPLICATION_ERRROR_CODE,
// No error. Used as bound while iterating.
QUIC_STREAM_LAST_ERROR,
};
@@ -499,6 +546,16 @@
DECODER_STREAM_ERROR = 0x202
};
+// Convert a QuicRstStreamErrorCode to an application error code to be used in
+// an IETF QUIC RESET_STREAM frame
+uint64_t RstStreamErrorCodeToIetfResetStreamErrorCode(
+ QuicRstStreamErrorCode rst_stream_error_code);
+
+// Convert the application error code of an IETF QUIC RESET_STREAM frame
+// to QuicRstStreamErrorCode.
+QuicRstStreamErrorCode IetfResetStreamErrorCodeToRstStreamErrorCode(
+ uint64_t ietf_error_code);
+
QUIC_EXPORT_PRIVATE inline std::string HistogramEnumString(
QuicErrorCode enum_value) {
return QuicErrorCodeToString(enum_value);
diff --git a/quic/core/quic_framer.cc b/quic/core/quic_framer.cc
index da5d4c5..63798c3 100644
--- a/quic/core/quic_framer.cc
+++ b/quic/core/quic_framer.cc
@@ -5770,9 +5770,8 @@
return false;
}
- // TODO(b/124216424): Translate IETF error code to QuicRstStreamErrorCode.
frame->error_code =
- static_cast<QuicRstStreamErrorCode>(frame->ietf_error_code);
+ IetfResetStreamErrorCodeToRstStreamErrorCode(frame->ietf_error_code);
if (!reader->ReadVarInt62(&frame->byte_offset)) {
set_detailed_error("Unable to read rst stream sent byte offset.");
diff --git a/quic/core/quic_framer_test.cc b/quic/core/quic_framer_test.cc
index 840cd31..fb9c2eb 100644
--- a/quic/core/quic_framer_test.cc
+++ b/quic/core/quic_framer_test.cc
@@ -4259,9 +4259,9 @@
{"Unable to read rst stream sent byte offset.",
{0x3A, 0x98, 0xFE, 0xDC,
0x32, 0x10, 0x76, 0x54}},
- // error code
+ // error code QUIC_STREAM_CANCELLED
{"Unable to read rst stream error code.",
- {0x00, 0x00, 0x00, 0x01}}
+ {0x00, 0x00, 0x00, 0x06}}
};
PacketFragments packet46 = {
@@ -4284,9 +4284,9 @@
{"Unable to read rst stream sent byte offset.",
{0x3A, 0x98, 0xFE, 0xDC,
0x32, 0x10, 0x76, 0x54}},
- // error code
+ // error code QUIC_STREAM_CANCELLED
{"Unable to read rst stream error code.",
- {0x00, 0x00, 0x00, 0x01}}
+ {0x00, 0x00, 0x00, 0x06}}
};
PacketFragments packet99 = {
@@ -4305,9 +4305,10 @@
// stream id
{"Unable to read IETF_RST_STREAM frame stream id/count.",
{kVarInt62FourBytes + 0x01, 0x02, 0x03, 0x04}},
- // application error code
+ // application error code H3_REQUEST_CANCELLED gets translated to
+ // QuicRstStreamErrorCode::QUIC_STREAM_CANCELLED.
{"Unable to read rst stream error code.",
- {kVarInt62OneByte + 0x01}},
+ {kVarInt62TwoBytes + 0x01, 0x0c}},
// Final Offset
{"Unable to read rst stream sent byte offset.",
{kVarInt62EightBytes + 0x3a, 0x98, 0xFE, 0xDC, 0x32, 0x10, 0x76, 0x54}}
@@ -4330,7 +4331,7 @@
PACKET_8BYTE_CONNECTION_ID, PACKET_0BYTE_CONNECTION_ID));
EXPECT_EQ(kStreamId, visitor_.rst_stream_frame_.stream_id);
- EXPECT_EQ(0x01, visitor_.rst_stream_frame_.error_code);
+ EXPECT_EQ(QUIC_STREAM_CANCELLED, visitor_.rst_stream_frame_.error_code);
EXPECT_EQ(kStreamOffset, visitor_.rst_stream_frame_.byte_offset);
CheckFramingBoundaries(fragments, QUIC_INVALID_RST_STREAM_DATA);
}
