1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #include "net/quic/quic_protocol.h"
7 #include "base/stl_util.h"
8 #include "net/quic/quic_utils.h"
10 using base::StringPiece
;
12 using std::numeric_limits
;
18 size_t GetPacketHeaderSize(const QuicPacketHeader
& header
) {
19 return GetPacketHeaderSize(header
.public_header
.connection_id_length
,
20 header
.public_header
.version_flag
,
21 header
.public_header
.sequence_number_length
,
22 header
.is_in_fec_group
);
25 size_t GetPacketHeaderSize(QuicConnectionIdLength connection_id_length
,
27 QuicSequenceNumberLength sequence_number_length
,
28 InFecGroup is_in_fec_group
) {
29 return kPublicFlagsSize
+ connection_id_length
+
30 (include_version
? kQuicVersionSize
: 0) + sequence_number_length
+
31 kPrivateFlagsSize
+ (is_in_fec_group
== IN_FEC_GROUP
? kFecGroupSize
: 0);
34 size_t GetStartOfFecProtectedData(
35 QuicConnectionIdLength connection_id_length
,
37 QuicSequenceNumberLength sequence_number_length
) {
38 return GetPacketHeaderSize(connection_id_length
,
40 sequence_number_length
,
44 size_t GetStartOfEncryptedData(
45 QuicConnectionIdLength connection_id_length
,
47 QuicSequenceNumberLength sequence_number_length
) {
48 // Don't include the fec size, since encryption starts before private flags.
49 return GetPacketHeaderSize(connection_id_length
,
51 sequence_number_length
,
52 NOT_IN_FEC_GROUP
) - kPrivateFlagsSize
;
55 QuicPacketPublicHeader::QuicPacketPublicHeader()
57 connection_id_length(PACKET_8BYTE_CONNECTION_ID
),
60 sequence_number_length(PACKET_6BYTE_SEQUENCE_NUMBER
) {
63 QuicPacketPublicHeader::QuicPacketPublicHeader(
64 const QuicPacketPublicHeader
& other
)
65 : connection_id(other
.connection_id
),
66 connection_id_length(other
.connection_id_length
),
67 reset_flag(other
.reset_flag
),
68 version_flag(other
.version_flag
),
69 sequence_number_length(other
.sequence_number_length
),
70 versions(other
.versions
) {
73 QuicPacketPublicHeader::~QuicPacketPublicHeader() {}
75 QuicPacketHeader::QuicPacketHeader()
79 packet_sequence_number(0),
80 is_in_fec_group(NOT_IN_FEC_GROUP
),
84 QuicPacketHeader::QuicPacketHeader(const QuicPacketPublicHeader
& header
)
85 : public_header(header
),
89 packet_sequence_number(0),
90 is_in_fec_group(NOT_IN_FEC_GROUP
),
94 QuicPublicResetPacket::QuicPublicResetPacket()
96 rejected_sequence_number(0) {}
98 QuicPublicResetPacket::QuicPublicResetPacket(
99 const QuicPacketPublicHeader
& header
)
100 : public_header(header
),
102 rejected_sequence_number(0) {}
104 QuicStreamFrame::QuicStreamFrame() : stream_id(0), fin(false), offset(0) {
107 QuicStreamFrame::QuicStreamFrame(const QuicStreamFrame
& frame
)
108 : stream_id(frame
.stream_id
),
110 offset(frame
.offset
),
114 QuicStreamFrame::QuicStreamFrame(QuicStreamId stream_id
,
116 QuicStreamOffset offset
,
118 : stream_id(stream_id
), fin(fin
), offset(offset
), data(data
) {
121 string
* QuicStreamFrame::GetDataAsString() const {
122 string
* data_string
= new string();
123 data_string
->reserve(data
.TotalBufferSize());
124 for (size_t i
= 0; i
< data
.Size(); ++i
) {
125 data_string
->append(static_cast<char*>(data
.iovec()[i
].iov_base
),
126 data
.iovec()[i
].iov_len
);
128 DCHECK_EQ(data_string
->size(), data
.TotalBufferSize());
132 uint32
MakeQuicTag(char a
, char b
, char c
, char d
) {
133 return static_cast<uint32
>(a
) |
134 static_cast<uint32
>(b
) << 8 |
135 static_cast<uint32
>(c
) << 16 |
136 static_cast<uint32
>(d
) << 24;
139 bool ContainsQuicTag(const QuicTagVector
& tag_vector
, QuicTag tag
) {
140 return std::find(tag_vector
.begin(), tag_vector
.end(), tag
)
144 QuicVersionVector
QuicSupportedVersions() {
145 QuicVersionVector supported_versions
;
146 for (size_t i
= 0; i
< arraysize(kSupportedQuicVersions
); ++i
) {
147 supported_versions
.push_back(kSupportedQuicVersions
[i
]);
149 return supported_versions
;
152 QuicTag
QuicVersionToQuicTag(const QuicVersion version
) {
154 case QUIC_VERSION_23
:
155 return MakeQuicTag('Q', '0', '2', '3');
156 case QUIC_VERSION_24
:
157 return MakeQuicTag('Q', '0', '2', '4');
159 // This shold be an ERROR because we should never attempt to convert an
160 // invalid QuicVersion to be written to the wire.
161 LOG(ERROR
) << "Unsupported QuicVersion: " << version
;
166 QuicVersion
QuicTagToQuicVersion(const QuicTag version_tag
) {
167 for (size_t i
= 0; i
< arraysize(kSupportedQuicVersions
); ++i
) {
168 if (version_tag
== QuicVersionToQuicTag(kSupportedQuicVersions
[i
])) {
169 return kSupportedQuicVersions
[i
];
172 // Reading from the client so this should not be considered an ERROR.
173 DVLOG(1) << "Unsupported QuicTag version: "
174 << QuicUtils::TagToString(version_tag
);
175 return QUIC_VERSION_UNSUPPORTED
;
178 #define RETURN_STRING_LITERAL(x) \
182 string
QuicVersionToString(const QuicVersion version
) {
184 RETURN_STRING_LITERAL(QUIC_VERSION_23
);
185 RETURN_STRING_LITERAL(QUIC_VERSION_24
);
187 return "QUIC_VERSION_UNSUPPORTED";
191 string
QuicVersionVectorToString(const QuicVersionVector
& versions
) {
193 for (size_t i
= 0; i
< versions
.size(); ++i
) {
197 result
.append(QuicVersionToString(versions
[i
]));
202 ostream
& operator<<(ostream
& os
, const QuicPacketHeader
& header
) {
203 os
<< "{ connection_id: " << header
.public_header
.connection_id
204 << ", connection_id_length:" << header
.public_header
.connection_id_length
205 << ", sequence_number_length:"
206 << header
.public_header
.sequence_number_length
207 << ", reset_flag: " << header
.public_header
.reset_flag
208 << ", version_flag: " << header
.public_header
.version_flag
;
209 if (header
.public_header
.version_flag
) {
211 for (size_t i
= 0; i
< header
.public_header
.versions
.size(); ++i
) {
212 os
<< header
.public_header
.versions
[0] << " ";
215 os
<< ", fec_flag: " << header
.fec_flag
216 << ", entropy_flag: " << header
.entropy_flag
217 << ", entropy hash: " << static_cast<int>(header
.entropy_hash
)
218 << ", sequence_number: " << header
.packet_sequence_number
219 << ", is_in_fec_group:" << header
.is_in_fec_group
220 << ", fec_group: " << header
.fec_group
<< "}\n";
224 bool IsAwaitingPacket(const QuicAckFrame
& ack_frame
,
225 QuicPacketSequenceNumber sequence_number
) {
226 return sequence_number
> ack_frame
.largest_observed
||
227 ContainsKey(ack_frame
.missing_packets
, sequence_number
);
230 void InsertMissingPacketsBetween(QuicAckFrame
* ack_frame
,
231 QuicPacketSequenceNumber lower
,
232 QuicPacketSequenceNumber higher
) {
233 for (QuicPacketSequenceNumber i
= lower
; i
< higher
; ++i
) {
234 ack_frame
->missing_packets
.insert(i
);
238 QuicStopWaitingFrame::QuicStopWaitingFrame()
243 QuicStopWaitingFrame::~QuicStopWaitingFrame() {}
245 QuicAckFrame::QuicAckFrame()
248 delta_time_largest_observed(QuicTime::Delta::Infinite()),
249 is_truncated(false) {}
251 QuicAckFrame::~QuicAckFrame() {}
253 QuicRstStreamErrorCode
AdjustErrorForVersion(
254 QuicRstStreamErrorCode error_code
,
255 QuicVersion version
) {
259 QuicRstStreamFrame::QuicRstStreamFrame()
261 error_code(QUIC_STREAM_NO_ERROR
) {
264 QuicRstStreamFrame::QuicRstStreamFrame(QuicStreamId stream_id
,
265 QuicRstStreamErrorCode error_code
,
266 QuicStreamOffset bytes_written
)
267 : stream_id(stream_id
),
268 error_code(error_code
),
269 byte_offset(bytes_written
) {
270 DCHECK_LE(error_code
, numeric_limits
<uint8
>::max());
273 QuicConnectionCloseFrame::QuicConnectionCloseFrame()
274 : error_code(QUIC_NO_ERROR
) {
277 QuicFrame::QuicFrame() {}
279 QuicFrame::QuicFrame(QuicPaddingFrame
* padding_frame
)
280 : type(PADDING_FRAME
),
281 padding_frame(padding_frame
) {
284 QuicFrame::QuicFrame(QuicStreamFrame
* stream_frame
)
285 : type(STREAM_FRAME
),
286 stream_frame(stream_frame
) {
289 QuicFrame::QuicFrame(QuicAckFrame
* frame
)
294 QuicFrame::QuicFrame(QuicStopWaitingFrame
* frame
)
295 : type(STOP_WAITING_FRAME
),
296 stop_waiting_frame(frame
) {
299 QuicFrame::QuicFrame(QuicPingFrame
* frame
)
304 QuicFrame::QuicFrame(QuicRstStreamFrame
* frame
)
305 : type(RST_STREAM_FRAME
),
306 rst_stream_frame(frame
) {
309 QuicFrame::QuicFrame(QuicConnectionCloseFrame
* frame
)
310 : type(CONNECTION_CLOSE_FRAME
),
311 connection_close_frame(frame
) {
314 QuicFrame::QuicFrame(QuicGoAwayFrame
* frame
)
315 : type(GOAWAY_FRAME
),
316 goaway_frame(frame
) {
319 QuicFrame::QuicFrame(QuicWindowUpdateFrame
* frame
)
320 : type(WINDOW_UPDATE_FRAME
),
321 window_update_frame(frame
) {
324 QuicFrame::QuicFrame(QuicBlockedFrame
* frame
)
325 : type(BLOCKED_FRAME
),
326 blocked_frame(frame
) {
329 QuicFecData::QuicFecData() : fec_group(0) {}
331 ostream
& operator<<(ostream
& os
, const QuicStopWaitingFrame
& sent_info
) {
332 os
<< "entropy_hash: " << static_cast<int>(sent_info
.entropy_hash
)
333 << " least_unacked: " << sent_info
.least_unacked
;
337 ostream
& operator<<(ostream
& os
, const QuicAckFrame
& ack_frame
) {
338 os
<< "entropy_hash: " << static_cast<int>(ack_frame
.entropy_hash
)
339 << " largest_observed: " << ack_frame
.largest_observed
340 << " delta_time_largest_observed: "
341 << ack_frame
.delta_time_largest_observed
.ToMicroseconds()
342 << " missing_packets: [ ";
343 for (SequenceNumberSet::const_iterator it
= ack_frame
.missing_packets
.begin();
344 it
!= ack_frame
.missing_packets
.end(); ++it
) {
347 os
<< " ] is_truncated: " << ack_frame
.is_truncated
;
348 os
<< " revived_packets: [ ";
349 for (SequenceNumberSet::const_iterator it
= ack_frame
.revived_packets
.begin();
350 it
!= ack_frame
.revived_packets
.end(); ++it
) {
353 os
<< " ] received_packets: [ ";
354 for (PacketTimeList::const_iterator it
=
355 ack_frame
.received_packet_times
.begin();
356 it
!= ack_frame
.received_packet_times
.end(); ++it
) {
357 os
<< it
->first
<< " at " << it
->second
.ToDebuggingValue() << " ";
363 ostream
& operator<<(ostream
& os
, const QuicFrame
& frame
) {
364 switch (frame
.type
) {
365 case PADDING_FRAME
: {
366 os
<< "type { PADDING_FRAME } ";
369 case RST_STREAM_FRAME
: {
370 os
<< "type { " << RST_STREAM_FRAME
<< " } " << *(frame
.rst_stream_frame
);
373 case CONNECTION_CLOSE_FRAME
: {
374 os
<< "type { CONNECTION_CLOSE_FRAME } "
375 << *(frame
.connection_close_frame
);
379 os
<< "type { GOAWAY_FRAME } " << *(frame
.goaway_frame
);
382 case WINDOW_UPDATE_FRAME
: {
383 os
<< "type { WINDOW_UPDATE_FRAME } " << *(frame
.window_update_frame
);
386 case BLOCKED_FRAME
: {
387 os
<< "type { BLOCKED_FRAME } " << *(frame
.blocked_frame
);
391 os
<< "type { STREAM_FRAME } " << *(frame
.stream_frame
);
395 os
<< "type { ACK_FRAME } " << *(frame
.ack_frame
);
398 case STOP_WAITING_FRAME
: {
399 os
<< "type { STOP_WAITING_FRAME } " << *(frame
.stop_waiting_frame
);
403 os
<< "type { PING_FRAME } ";
407 LOG(ERROR
) << "Unknown frame type: " << frame
.type
;
414 ostream
& operator<<(ostream
& os
, const QuicRstStreamFrame
& rst_frame
) {
415 os
<< "stream_id { " << rst_frame
.stream_id
<< " } "
416 << "error_code { " << rst_frame
.error_code
<< " } "
417 << "error_details { " << rst_frame
.error_details
<< " }\n";
421 ostream
& operator<<(ostream
& os
,
422 const QuicConnectionCloseFrame
& connection_close_frame
) {
423 os
<< "error_code { " << connection_close_frame
.error_code
<< " } "
424 << "error_details { " << connection_close_frame
.error_details
<< " }\n";
428 ostream
& operator<<(ostream
& os
, const QuicGoAwayFrame
& goaway_frame
) {
429 os
<< "error_code { " << goaway_frame
.error_code
<< " } "
430 << "last_good_stream_id { " << goaway_frame
.last_good_stream_id
<< " } "
431 << "reason_phrase { " << goaway_frame
.reason_phrase
<< " }\n";
435 ostream
& operator<<(ostream
& os
,
436 const QuicWindowUpdateFrame
& window_update_frame
) {
437 os
<< "stream_id { " << window_update_frame
.stream_id
<< " } "
438 << "byte_offset { " << window_update_frame
.byte_offset
<< " }\n";
442 ostream
& operator<<(ostream
& os
, const QuicBlockedFrame
& blocked_frame
) {
443 os
<< "stream_id { " << blocked_frame
.stream_id
<< " }\n";
447 ostream
& operator<<(ostream
& os
, const QuicStreamFrame
& stream_frame
) {
448 os
<< "stream_id { " << stream_frame
.stream_id
<< " } "
449 << "fin { " << stream_frame
.fin
<< " } "
450 << "offset { " << stream_frame
.offset
<< " } "
452 << QuicUtils::StringToHexASCIIDump(*(stream_frame
.GetDataAsString()))
457 QuicGoAwayFrame::QuicGoAwayFrame()
458 : error_code(QUIC_NO_ERROR
),
459 last_good_stream_id(0) {
462 QuicGoAwayFrame::QuicGoAwayFrame(QuicErrorCode error_code
,
463 QuicStreamId last_good_stream_id
,
464 const string
& reason
)
465 : error_code(error_code
),
466 last_good_stream_id(last_good_stream_id
),
467 reason_phrase(reason
) {
468 DCHECK_LE(error_code
, numeric_limits
<uint8
>::max());
471 QuicData::QuicData(const char* buffer
,
475 owns_buffer_(false) {
478 QuicData::QuicData(char* buffer
,
483 owns_buffer_(owns_buffer
) {
486 QuicData::~QuicData() {
488 delete [] const_cast<char*>(buffer_
);
492 QuicWindowUpdateFrame::QuicWindowUpdateFrame(QuicStreamId stream_id
,
493 QuicStreamOffset byte_offset
)
494 : stream_id(stream_id
),
495 byte_offset(byte_offset
) {}
497 QuicBlockedFrame::QuicBlockedFrame(QuicStreamId stream_id
)
498 : stream_id(stream_id
) {}
500 QuicPacket::QuicPacket(char* buffer
,
503 QuicConnectionIdLength connection_id_length
,
504 bool includes_version
,
505 QuicSequenceNumberLength sequence_number_length
)
506 : QuicData(buffer
, length
, owns_buffer
),
508 connection_id_length_(connection_id_length
),
509 includes_version_(includes_version
),
510 sequence_number_length_(sequence_number_length
) {
513 QuicEncryptedPacket::QuicEncryptedPacket(const char* buffer
,
515 : QuicData(buffer
, length
) {
518 QuicEncryptedPacket::QuicEncryptedPacket(char* buffer
,
521 : QuicData(buffer
, length
, owns_buffer
) {
524 StringPiece
QuicPacket::FecProtectedData() const {
525 const size_t start_of_fec
= GetStartOfFecProtectedData(
526 connection_id_length_
, includes_version_
, sequence_number_length_
);
527 return StringPiece(data() + start_of_fec
, length() - start_of_fec
);
530 StringPiece
QuicPacket::AssociatedData() const {
532 data() + kStartOfHashData
,
533 GetStartOfEncryptedData(
534 connection_id_length_
, includes_version_
, sequence_number_length_
) -
538 StringPiece
QuicPacket::BeforePlaintext() const {
539 return StringPiece(data(), GetStartOfEncryptedData(connection_id_length_
,
541 sequence_number_length_
));
544 StringPiece
QuicPacket::Plaintext() const {
545 const size_t start_of_encrypted_data
=
546 GetStartOfEncryptedData(
547 connection_id_length_
, includes_version_
, sequence_number_length_
);
548 return StringPiece(data() + start_of_encrypted_data
,
549 length() - start_of_encrypted_data
);
552 RetransmittableFrames::RetransmittableFrames(EncryptionLevel level
)
553 : encryption_level_(level
), has_crypto_handshake_(NOT_HANDSHAKE
) {
556 RetransmittableFrames::~RetransmittableFrames() {
557 for (QuicFrames::iterator it
= frames_
.begin(); it
!= frames_
.end(); ++it
) {
560 delete it
->padding_frame
;
563 delete it
->stream_frame
;
566 delete it
->ack_frame
;
568 case STOP_WAITING_FRAME
:
569 delete it
->stop_waiting_frame
;
572 delete it
->ping_frame
;
574 case RST_STREAM_FRAME
:
575 delete it
->rst_stream_frame
;
577 case CONNECTION_CLOSE_FRAME
:
578 delete it
->connection_close_frame
;
581 delete it
->goaway_frame
;
583 case WINDOW_UPDATE_FRAME
:
584 delete it
->window_update_frame
;
587 delete it
->blocked_frame
;
589 case NUM_FRAME_TYPES
:
590 DCHECK(false) << "Cannot delete type: " << it
->type
;
593 STLDeleteElements(&stream_data_
);
596 const QuicFrame
& RetransmittableFrames::AddStreamFrame(
597 QuicStreamFrame
* stream_frame
) {
598 // Make an owned copy of the stream frame's data.
599 stream_data_
.push_back(stream_frame
->GetDataAsString());
600 // Ensure the stream frame's IOVector points to the owned copy of the data.
601 stream_frame
->data
.Clear();
602 stream_frame
->data
.Append(const_cast<char*>(stream_data_
.back()->data()),
603 stream_data_
.back()->size());
604 frames_
.push_back(QuicFrame(stream_frame
));
605 if (stream_frame
->stream_id
== kCryptoStreamId
) {
606 has_crypto_handshake_
= IS_HANDSHAKE
;
608 return frames_
.back();
611 const QuicFrame
& RetransmittableFrames::AddNonStreamFrame(
612 const QuicFrame
& frame
) {
613 DCHECK_NE(frame
.type
, STREAM_FRAME
);
614 frames_
.push_back(frame
);
615 return frames_
.back();
618 SerializedPacket::SerializedPacket(
619 QuicPacketSequenceNumber sequence_number
,
620 QuicSequenceNumberLength sequence_number_length
,
621 QuicEncryptedPacket
* packet
,
622 QuicPacketEntropyHash entropy_hash
,
623 RetransmittableFrames
* retransmittable_frames
)
624 : sequence_number(sequence_number
),
625 sequence_number_length(sequence_number_length
),
627 entropy_hash(entropy_hash
),
628 retransmittable_frames(retransmittable_frames
),
629 is_fec_packet(false) {
632 SerializedPacket::~SerializedPacket() {}
634 QuicEncryptedPacket
* QuicEncryptedPacket::Clone() const {
635 char* buffer
= new char[this->length()];
636 memcpy(buffer
, this->data(), this->length());
637 return new QuicEncryptedPacket(buffer
, this->length(), true);
640 ostream
& operator<<(ostream
& os
, const QuicEncryptedPacket
& s
) {
641 os
<< s
.length() << "-byte data";
645 TransmissionInfo::TransmissionInfo()
646 : retransmittable_frames(nullptr),
647 sequence_number_length(PACKET_1BYTE_SEQUENCE_NUMBER
),
648 sent_time(QuicTime::Zero()),
651 transmission_type(NOT_RETRANSMISSION
),
652 all_transmissions(nullptr),
655 is_fec_packet(false) {
658 TransmissionInfo::TransmissionInfo(
659 RetransmittableFrames
* retransmittable_frames
,
660 QuicSequenceNumberLength sequence_number_length
,
661 TransmissionType transmission_type
,
663 QuicByteCount bytes_sent
,
665 : retransmittable_frames(retransmittable_frames
),
666 sequence_number_length(sequence_number_length
),
667 sent_time(sent_time
),
668 bytes_sent(bytes_sent
),
670 transmission_type(transmission_type
),
671 all_transmissions(nullptr),
674 is_fec_packet(is_fec_packet
) {