net/quic/quic_packet_creator.cc

   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.
   4
   5 #include "net/quic/quic_packet_creator.h"
   6
   7 #include "base/basictypes.h"
   8 #include "base/logging.h"
   9 #include "net/quic/crypto/quic_random.h"
  10 #include "net/quic/quic_ack_notifier.h"
  11 #include "net/quic/quic_fec_group.h"
  12 #include "net/quic/quic_utils.h"
  13
  14 using base::StringPiece;
  15 using std::make_pair;
  16 using std::max;
  17 using std::min;
  18 using std::pair;
  19 using std::vector;
  20
  21 namespace net {
  22
  23 // A QuicRandom wrapper that gets a bucket of entropy and distributes it
  24 // bit-by-bit. Replenishes the bucket as needed. Not thread-safe. Expose this
  25 // class if single bit randomness is needed elsewhere.
  26 class QuicRandomBoolSource {
  27  public:
  28   // random: Source of entropy. Not owned.
  29   explicit QuicRandomBoolSource(QuicRandom* random)
  30       : random_(random),
  31         bit_bucket_(0),
  32         bit_mask_(0) {}
  33
  34   ~QuicRandomBoolSource() {}
  35
  36   // Returns the next random bit from the bucket.
  37   bool RandBool() {
  38     if (bit_mask_ == 0) {
  39       bit_bucket_ = random_->RandUint64();
  40       bit_mask_ = 1;
  41     }
  42     bool result = ((bit_bucket_ & bit_mask_) != 0);
  43     bit_mask_ <<= 1;
  44     return result;
  45   }
  46
  47  private:
  48   // Source of entropy.
  49   QuicRandom* random_;
  50   // Stored random bits.
  51   uint64 bit_bucket_;
  52   // The next available bit has "1" in the mask. Zero means empty bucket.
  53   uint64 bit_mask_;
  54
  55   DISALLOW_COPY_AND_ASSIGN(QuicRandomBoolSource);
  56 };
  57
  58 QuicPacketCreator::QuicPacketCreator(QuicGuid guid,
  59                                      QuicFramer* framer,
  60                                      QuicRandom* random_generator,
  61                                      bool is_server)
  62     : guid_(guid),
  63       framer_(framer),
  64       random_bool_source_(new QuicRandomBoolSource(random_generator)),
  65       sequence_number_(0),
  66       fec_group_number_(0),
  67       is_server_(is_server),
  68       send_version_in_packet_(!is_server),
  69       sequence_number_length_(options_.send_sequence_number_length),
  70       packet_size_(0) {
  71   framer_->set_fec_builder(this);
  72 }
  73
  74 QuicPacketCreator::~QuicPacketCreator() {
  75 }
  76
  77 void QuicPacketCreator::OnBuiltFecProtectedPayload(
  78     const QuicPacketHeader& header, StringPiece payload) {
  79   if (fec_group_.get()) {
  80     DCHECK_NE(0u, header.fec_group);
  81     fec_group_->Update(header, payload);
  82   }
  83 }
  84
  85 bool QuicPacketCreator::ShouldSendFec(bool force_close) const {
  86   return fec_group_.get() != NULL && fec_group_->NumReceivedPackets() > 0 &&
  87       (force_close ||
  88        fec_group_->NumReceivedPackets() >= options_.max_packets_per_fec_group);
  89 }
  90
  91 void QuicPacketCreator::MaybeStartFEC() {
  92   // Don't send FEC until QUIC_VERSION_15.
  93   if (framer_->version() > QUIC_VERSION_14 &&
  94       options_.max_packets_per_fec_group > 0 && fec_group_.get() == NULL) {
  95     DCHECK(queued_frames_.empty());
  96     // Set the fec group number to the sequence number of the next packet.
  97     fec_group_number_ = sequence_number() + 1;
  98     fec_group_.reset(new QuicFecGroup());
  99   }
 100 }
 101
 102 // Stops serializing version of the protocol in packets sent after this call.
 103 // A packet that is already open might send kQuicVersionSize bytes less than the
 104 // maximum packet size if we stop sending version before it is serialized.
 105 void QuicPacketCreator::StopSendingVersion() {
 106   DCHECK(send_version_in_packet_);
 107   send_version_in_packet_ = false;
 108   if (packet_size_ > 0) {
 109     DCHECK_LT(kQuicVersionSize, packet_size_);
 110     packet_size_ -= kQuicVersionSize;
 111   }
 112 }
 113
 114 void QuicPacketCreator::UpdateSequenceNumberLength(
 115       QuicPacketSequenceNumber least_packet_awaited_by_peer,
 116       QuicByteCount bytes_per_second) {
 117   DCHECK_LE(least_packet_awaited_by_peer, sequence_number_ + 1);
 118   // Since the packet creator will not change sequence number length mid FEC
 119   // group, include the size of an FEC group to be safe.
 120   const QuicPacketSequenceNumber current_delta =
 121       options_.max_packets_per_fec_group + sequence_number_ + 1
 122       - least_packet_awaited_by_peer;
 123   const uint64 congestion_window =
 124       bytes_per_second / options_.max_packet_length;
 125   const uint64 delta = max(current_delta, congestion_window);
 126
 127   options_.send_sequence_number_length =
 128       QuicFramer::GetMinSequenceNumberLength(delta * 4);
 129 }
 130
 131 bool QuicPacketCreator::HasRoomForStreamFrame(QuicStreamId id,
 132                                               QuicStreamOffset offset) const {
 133   return BytesFree() >
 134       QuicFramer::GetMinStreamFrameSize(framer_->version(), id, offset, true);
 135 }
 136
 137 // static
 138 size_t QuicPacketCreator::StreamFramePacketOverhead(
 139     QuicVersion version,
 140     QuicGuidLength guid_length,
 141     bool include_version,
 142     QuicSequenceNumberLength sequence_number_length,
 143     InFecGroup is_in_fec_group) {
 144   return GetPacketHeaderSize(guid_length, include_version,
 145                              sequence_number_length, is_in_fec_group) +
 146       // Assumes this is a stream with a single lone packet.
 147       QuicFramer::GetMinStreamFrameSize(version, 1u, 0u, true);
 148 }
 149
 150 size_t QuicPacketCreator::CreateStreamFrame(QuicStreamId id,
 151                                             const IOVector& data,
 152                                             QuicStreamOffset offset,
 153                                             bool fin,
 154                                             QuicFrame* frame) {
 155   DCHECK_GT(options_.max_packet_length,
 156             StreamFramePacketOverhead(
 157                 framer_->version(), PACKET_8BYTE_GUID, kIncludeVersion,
 158                 PACKET_6BYTE_SEQUENCE_NUMBER, IN_FEC_GROUP));
 159   if (!HasRoomForStreamFrame(id, offset)) {
 160     LOG(DFATAL) << "No room for Stream frame, BytesFree: " << BytesFree()
 161                 << " MinStreamFrameSize: "
 162                 << QuicFramer::GetMinStreamFrameSize(
 163                     framer_->version(), id, offset, true);
 164   }
 165
 166   if (data.Empty()) {
 167     if (!fin) {
 168       LOG(DFATAL) << "Creating a stream frame with no data or fin.";
 169     }
 170     // Create a new packet for the fin, if necessary.
 171     *frame = QuicFrame(new QuicStreamFrame(id, true, offset, data));
 172     return 0;
 173   }
 174
 175   const size_t free_bytes = BytesFree();
 176   size_t bytes_consumed = 0;
 177   const size_t data_size = data.TotalBufferSize();
 178
 179   // When a STREAM frame is the last frame in a packet, it consumes two fewer
 180   // bytes of framing overhead.
 181   // Anytime more data is available than fits in with the extra two bytes,
 182   // the frame will be the last, and up to two extra bytes are consumed.
 183   // TODO(ianswett): If QUIC pads, the 1 byte PADDING frame does not fit when
 184   // 1 byte is available, because then the STREAM frame isn't the last.
 185
 186   // The minimum frame size(0 bytes of data) if it's not the last frame.
 187   size_t min_frame_size = QuicFramer::GetMinStreamFrameSize(
 188       framer_->version(), id, offset, false);
 189   // Check if it's the last frame in the packet.
 190   if (data_size + min_frame_size > free_bytes) {
 191     // The minimum frame size(0 bytes of data) if it is the last frame.
 192     size_t min_last_frame_size = QuicFramer::GetMinStreamFrameSize(
 193         framer_->version(), id, offset, true);
 194     bytes_consumed =
 195         min<size_t>(free_bytes - min_last_frame_size, data_size);
 196   } else {
 197     DCHECK_LT(data_size, BytesFree());
 198     bytes_consumed = data_size;
 199   }
 200
 201   bool set_fin = fin && bytes_consumed == data_size;  // Last frame.
 202   IOVector frame_data;
 203   frame_data.AppendIovecAtMostBytes(data.iovec(), data.Size(),
 204                                     bytes_consumed);
 205   DCHECK_EQ(frame_data.TotalBufferSize(), bytes_consumed);
 206   *frame = QuicFrame(new QuicStreamFrame(id, set_fin, offset, frame_data));
 207   return bytes_consumed;
 208 }
 209
 210 size_t QuicPacketCreator::CreateStreamFrameWithNotifier(
 211     QuicStreamId id,
 212     const IOVector& data,
 213     QuicStreamOffset offset,
 214     bool fin,
 215     QuicAckNotifier* notifier,
 216     QuicFrame* frame) {
 217   size_t bytes_consumed = CreateStreamFrame(id, data, offset, fin, frame);
 218
 219   // The frame keeps track of the QuicAckNotifier until it is serialized into
 220   // a packet. At that point the notifier is informed of the sequence number
 221   // of the packet that this frame was eventually sent in.
 222   frame->stream_frame->notifier = notifier;
 223
 224   return bytes_consumed;
 225 }
 226
 227 SerializedPacket QuicPacketCreator::ReserializeAllFrames(
 228     const QuicFrames& frames,
 229     QuicSequenceNumberLength original_length) {
 230   const QuicSequenceNumberLength start_length = sequence_number_length_;
 231   const QuicSequenceNumberLength start_options_length =
 232       options_.send_sequence_number_length;
 233   const QuicFecGroupNumber start_fec_group = fec_group_number_;
 234   const size_t start_max_packets_per_fec_group =
 235       options_.max_packets_per_fec_group;
 236
 237   // Temporarily set the sequence number length and disable FEC.
 238   sequence_number_length_ = original_length;
 239   options_.send_sequence_number_length = original_length;
 240   fec_group_number_ = 0;
 241   options_.max_packets_per_fec_group = 0;
 242
 243   // Serialize the packet and restore the fec and sequence number length state.
 244   SerializedPacket serialized_packet = SerializeAllFrames(frames);
 245   sequence_number_length_ = start_length;
 246   options_.send_sequence_number_length = start_options_length;
 247   fec_group_number_ = start_fec_group;
 248   options_.max_packets_per_fec_group = start_max_packets_per_fec_group;
 249
 250   return serialized_packet;
 251 }
 252
 253 SerializedPacket QuicPacketCreator::SerializeAllFrames(
 254     const QuicFrames& frames) {
 255   // TODO(satyamshekhar): Verify that this DCHECK won't fail. What about queued
 256   // frames from SendStreamData()[send_stream_should_flush_ == false &&
 257   // data.empty() == true] and retransmit due to RTO.
 258   DCHECK_EQ(0u, queued_frames_.size());
 259   if (frames.empty()) {
 260     LOG(DFATAL) << "Attempt to serialize empty packet";
 261   }
 262   for (size_t i = 0; i < frames.size(); ++i) {
 263     bool success = AddFrame(frames[i], false);
 264     DCHECK(success);
 265   }
 266   SerializedPacket packet = SerializePacket();
 267   DCHECK(packet.retransmittable_frames == NULL);
 268   return packet;
 269 }
 270
 271 bool QuicPacketCreator::HasPendingFrames() {
 272   return !queued_frames_.empty();
 273 }
 274
 275 size_t QuicPacketCreator::BytesFree() const {
 276   const size_t max_plaintext_size =
 277       framer_->GetMaxPlaintextSize(options_.max_packet_length);
 278   DCHECK_GE(max_plaintext_size, PacketSize());
 279
 280   // If the last frame in the packet is a stream frame, then it can be
 281   // two bytes smaller than if it were not the last.  So this means that
 282   // there are two fewer bytes available to the next frame in this case.
 283   bool has_trailing_stream_frame =
 284       !queued_frames_.empty() && queued_frames_.back().type == STREAM_FRAME;
 285   size_t expanded_packet_size = PacketSize() +
 286       (has_trailing_stream_frame ? kQuicStreamPayloadLengthSize : 0);
 287
 288   if (expanded_packet_size  >= max_plaintext_size) {
 289     return 0;
 290   }
 291   return max_plaintext_size - expanded_packet_size;
 292 }
 293
 294 size_t QuicPacketCreator::PacketSize() const {
 295   if (queued_frames_.empty()) {
 296     // Only adjust the sequence number length when the FEC group is not open,
 297     // to ensure no packets in a group are too large.
 298     if (fec_group_.get() == NULL ||
 299         fec_group_->NumReceivedPackets() == 0) {
 300       sequence_number_length_ = options_.send_sequence_number_length;
 301     }
 302     packet_size_ = GetPacketHeaderSize(options_.send_guid_length,
 303                                        send_version_in_packet_,
 304                                        sequence_number_length_,
 305                                        options_.max_packets_per_fec_group == 0 ?
 306                                            NOT_IN_FEC_GROUP : IN_FEC_GROUP);
 307   }
 308   return packet_size_;
 309 }
 310
 311 bool QuicPacketCreator::AddSavedFrame(const QuicFrame& frame) {
 312   return AddFrame(frame, true);
 313 }
 314
 315 SerializedPacket QuicPacketCreator::SerializePacket() {
 316   if (queued_frames_.empty()) {
 317     LOG(DFATAL) << "Attempt to serialize empty packet";
 318   }
 319   QuicPacketHeader header;
 320   FillPacketHeader(fec_group_number_, false, &header);
 321
 322   MaybeAddPadding();
 323
 324   size_t max_plaintext_size =
 325       framer_->GetMaxPlaintextSize(options_.max_packet_length);
 326   DCHECK_GE(max_plaintext_size, packet_size_);
 327   // ACK and CONNECTION_CLOSE Frames will be truncated only if they're
 328   // the first frame in the packet.  If truncation is to occur, then
 329   // GetSerializedFrameLength will have returned all bytes free.
 330   bool possibly_truncated =
 331       packet_size_ != max_plaintext_size ||
 332       queued_frames_.size() != 1 ||
 333       (queued_frames_.back().type == ACK_FRAME ||
 334        queued_frames_.back().type == CONNECTION_CLOSE_FRAME);
 335   SerializedPacket serialized =
 336       framer_->BuildDataPacket(header, queued_frames_, packet_size_);
 337   if (!serialized.packet) {
 338     LOG(DFATAL) << "Failed to serialize " << queued_frames_.size()
 339                 << " frames.";
 340   }
 341   // Because of possible truncation, we can't be confident that our
 342   // packet size calculation worked correctly.
 343   if (!possibly_truncated)
 344     DCHECK_EQ(packet_size_, serialized.packet->length());
 345
 346   packet_size_ = 0;
 347   queued_frames_.clear();
 348   serialized.retransmittable_frames = queued_retransmittable_frames_.release();
 349   return serialized;
 350 }
 351
 352 SerializedPacket QuicPacketCreator::SerializeFec() {
 353   DCHECK_LT(0u, fec_group_->NumReceivedPackets());
 354   DCHECK_EQ(0u, queued_frames_.size());
 355   QuicPacketHeader header;
 356   FillPacketHeader(fec_group_number_, true, &header);
 357   QuicFecData fec_data;
 358   fec_data.fec_group = fec_group_->min_protected_packet();
 359   fec_data.redundancy = fec_group_->payload_parity();
 360   SerializedPacket serialized = framer_->BuildFecPacket(header, fec_data);
 361   fec_group_.reset(NULL);
 362   fec_group_number_ = 0;
 363   packet_size_ = 0;
 364   if (!serialized.packet) {
 365     LOG(DFATAL) << "Failed to serialize fec packet for group:"
 366                 << fec_data.fec_group;
 367   }
 368   DCHECK_GE(options_.max_packet_length, serialized.packet->length());
 369   return serialized;
 370 }
 371
 372 SerializedPacket QuicPacketCreator::SerializeConnectionClose(
 373     QuicConnectionCloseFrame* close_frame) {
 374   QuicFrames frames;
 375   frames.push_back(QuicFrame(close_frame));
 376   return SerializeAllFrames(frames);
 377 }
 378
 379 QuicEncryptedPacket* QuicPacketCreator::SerializeVersionNegotiationPacket(
 380     const QuicVersionVector& supported_versions) {
 381   DCHECK(is_server_);
 382   QuicPacketPublicHeader header;
 383   header.guid = guid_;
 384   header.reset_flag = false;
 385   header.version_flag = true;
 386   header.versions = supported_versions;
 387   QuicEncryptedPacket* encrypted =
 388       framer_->BuildVersionNegotiationPacket(header, supported_versions);
 389   DCHECK(encrypted);
 390   DCHECK_GE(options_.max_packet_length, encrypted->length());
 391   return encrypted;
 392 }
 393
 394 void QuicPacketCreator::FillPacketHeader(QuicFecGroupNumber fec_group,
 395                                          bool fec_flag,
 396                                          QuicPacketHeader* header) {
 397   header->public_header.guid = guid_;
 398   header->public_header.reset_flag = false;
 399   header->public_header.version_flag = send_version_in_packet_;
 400   header->fec_flag = fec_flag;
 401   header->packet_sequence_number = ++sequence_number_;
 402   header->public_header.sequence_number_length = sequence_number_length_;
 403   header->entropy_flag = random_bool_source_->RandBool();
 404   header->is_in_fec_group = fec_group == 0 ? NOT_IN_FEC_GROUP : IN_FEC_GROUP;
 405   header->fec_group = fec_group;
 406 }
 407
 408 bool QuicPacketCreator::ShouldRetransmit(const QuicFrame& frame) {
 409   switch (frame.type) {
 410     case ACK_FRAME:
 411     case CONGESTION_FEEDBACK_FRAME:
 412     case PADDING_FRAME:
 413     case STOP_WAITING_FRAME:
 414       return false;
 415     default:
 416       return true;
 417   }
 418 }
 419
 420 bool QuicPacketCreator::AddFrame(const QuicFrame& frame,
 421                                  bool save_retransmittable_frames) {
 422   DVLOG(1) << "Adding frame: " << frame;
 423   size_t frame_len = framer_->GetSerializedFrameLength(
 424       frame, BytesFree(), queued_frames_.empty(), true,
 425       options()->send_sequence_number_length);
 426   if (frame_len == 0) {
 427     return false;
 428   }
 429   DCHECK_LT(0u, packet_size_);
 430   MaybeStartFEC();
 431   packet_size_ += frame_len;
 432   // If the last frame in the packet was a stream frame, then once we add the
 433   // new frame it's serialization will be two bytes larger.
 434   if (!queued_frames_.empty() && queued_frames_.back().type == STREAM_FRAME) {
 435     packet_size_ += kQuicStreamPayloadLengthSize;
 436   }
 437   if (save_retransmittable_frames && ShouldRetransmit(frame)) {
 438     if (queued_retransmittable_frames_.get() == NULL) {
 439       queued_retransmittable_frames_.reset(new RetransmittableFrames());
 440     }
 441     if (frame.type == STREAM_FRAME) {
 442       queued_frames_.push_back(
 443           queued_retransmittable_frames_->AddStreamFrame(frame.stream_frame));
 444     } else {
 445       queued_frames_.push_back(
 446           queued_retransmittable_frames_->AddNonStreamFrame(frame));
 447     }
 448   } else {
 449     queued_frames_.push_back(frame);
 450   }
 451   return true;
 452 }
 453
 454 void QuicPacketCreator::MaybeAddPadding() {
 455   if (BytesFree() == 0) {
 456     // Don't pad full packets.
 457     return;
 458   }
 459
 460   // If any of the frames in the current packet are on the crypto stream
 461   // then they contain handshake messagses, and we should pad them.
 462   bool is_handshake = false;
 463   for (size_t i = 0; i < queued_frames_.size(); ++i) {
 464     if (queued_frames_[i].type == STREAM_FRAME &&
 465         queued_frames_[i].stream_frame->stream_id == kCryptoStreamId) {
 466       is_handshake = true;
 467       break;
 468     }
 469   }
 470   if (!is_handshake) {
 471     return;
 472   }
 473
 474   QuicPaddingFrame padding;
 475   bool success = AddFrame(QuicFrame(&padding), false);
 476   DCHECK(success);
 477 }
 478
 479 }  // namespace net