Introduces ability for session to wait on a migration trigger for a new

net/quic/chromium/quic_chromium_client_session.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "net/quic/chromium/quic_chromium_client_session.h"
 
 #include <openssl/ssl.h>
 
 #include <utility>
 
@@ skipping 39 matching lines @@
 // connection migration. A new Reader is created every time this endpoint's
 // IP address changes.
 const size_t kMaxReadersPerQuicSession = 5;
 
 // Size of the MRU cache of Token Binding signatures. Since the material being
 // signed is constant and there aren't many keys being used to sign, a fairly
 // small number was chosen, somewhat arbitrarily, and to match
 // SSLClientSocketImpl.
 const size_t kTokenBindingSignatureMapSize = 10;
 
+// Time to wait (in seconds) when no networks are available and
+// migrating sessions need to wait for a new network to connect.
+const size_t kWaitTimeForNewNetworkSecs = 10;
+
 // Histograms for tracking down the crashes from http://crbug.com/354669
 // Note: these values must be kept in sync with the corresponding values in:
 // tools/metrics/histograms/histograms.xml
 enum Location {
   DESTRUCTOR = 0,
   ADD_OBSERVER = 1,
   TRY_CREATE_STREAM = 2,
   CREATE_OUTGOING_RELIABLE_STREAM = 3,
   NOTIFY_FACTORY_OF_SESSION_CLOSED_LATER = 4,
   NOTIFY_FACTORY_OF_SESSION_CLOSED = 5,
@@ skipping 923 matching lines @@
   // that the actual migration happens from the message loop instead
   // of under the call stack of QuicConnection::WritePacket.
   return ERR_IO_PENDING;
 }
 
 void QuicChromiumClientSession::MigrateSessionOnWriteError() {
   // If migration_pending_ is false, an earlier task completed migration.
   if (!migration_pending_)
     return;
 
-  if (stream_factory_ != nullptr &&
-      stream_factory_->MaybeMigrateSingleSession(this, WRITE_ERROR) ==
-          MigrationResult::SUCCESS) {
+  MigrationResult result = MigrationResult::FAILURE;
+  if (stream_factory_ != nullptr) {
+    result = stream_factory_->MaybeMigrateSingleSession(this, WRITE_ERROR);
+  }
+
+  if (result != MigrationResult::FAILURE) {
+    if (result == MigrationResult::NO_NEW_NETWORK)
+      OnNoNewNetwork();
     return;
   }
 
   // Close the connection if migration failed. Do not cause a
   // connection close packet to be sent since socket may be borked.
   connection()->CloseConnection(QUIC_PACKET_WRITE_ERROR,
                                 "Write and subsequent migration failed",
                                 ConnectionCloseBehavior::SILENT_CLOSE);
 }
 
+void QuicChromiumClientSession::OnNoNewNetwork() {
+  // When called from a network notification, migration_pending_ may
+  // be false.  When a new network connects later, migration will
+  // proceed via OnNetworkConnected only if a migration is pending, so
+  // ensure that migration is pending.

[Ryan Hamilton, 2016/09/13 02:57:31]

Hm. This is still confusing. I think you're explaining why migration_pending_
might not be set to true already?  But that doesn't seem terribly helpful. I
think the point is that migration_pending_ needs to be true while we're waiting
(either for a PostTask via OnWriteError or an NCN notification) for a migration
to happen. Since this method starts waiting we need to mark that we're waiting.
At that point, I'd probably just drop the comment.

[Jana, 2016/09/13 03:12:14]

Yeah, re-reading it, the comment seems to be going all over the place. Dropping
it. Feel free to propose a better comment if you can think of one.

+  migration_pending_ = true;
+  // Block the packet writer to avoid any writes while migration is in progress.
+  static_cast<QuicChromiumPacketWriter*>(connection()->writer())
+      ->set_write_blocked(true);
+  // Post a task to maybe close the session if the alarm fires.
+  task_runner_->PostDelayedTask(
+      FROM_HERE, base::Bind(&QuicChromiumClientSession::OnMigrationTimeout,
+                            weak_factory_.GetWeakPtr(), sockets_.size()),
+      base::TimeDelta::FromSeconds(kWaitTimeForNewNetworkSecs));
+}
+
 void QuicChromiumClientSession::WriteToNewSocket() {
   // Prevent any pending migration from executing.
   migration_pending_ = false;
-
   static_cast<QuicChromiumPacketWriter*>(connection()->writer())
       ->set_write_blocked(false);
-  DCHECK(!connection()->writer()->IsWriteBlocked());
-
   if (packet_ == nullptr) {
     // Unblock the connection before sending a PING packet, since it
     // may have been blocked before the migration started.
     connection()->OnCanWrite();
     connection()->SendPing();
     return;
   }
 
   // Set packet_ to null first before calling WritePacketToSocket since
   // that method may set packet_ if there is a write error.
   scoped_refptr<StringIOBuffer> packet = packet_;
   packet_ = nullptr;
-
   // The connection is waiting for the original write to complete
   // asynchronously. The new writer will notify the connection if the
   // write below completes asynchronously, but a synchronous competion
   // must be propagated back to the connection here.
   WriteResult result =
       static_cast<QuicChromiumPacketWriter*>(connection()->writer())
           ->WritePacketToSocket(packet);
-
   if (result.error_code == ERR_IO_PENDING)
     return;
   // All write errors should be mapped into ERR_IO_PENDING by
   // HandleWriteError.
   DCHECK_LT(0, result.error_code);
   connection()->OnCanWrite();
 }
 
+void QuicChromiumClientSession::OnMigrationTimeout(size_t num_sockets) {
+  // If number of sockets has increased, this migration task is stale.
+  if (num_sockets < sockets_.size())
+    return;
+  UMA_HISTOGRAM_ENUMERATION("Net.QuicSession.ConnectionMigration",
+                            MIGRATION_STATUS_NO_ALTERNATE_NETWORK,
+                            MIGRATION_STATUS_MAX);
+  CloseSessionOnError(ERR_NETWORK_CHANGED,
+                      QUIC_CONNECTION_MIGRATION_NO_NEW_NETWORK);
+}
+
+void QuicChromiumClientSession::OnNetworkConnected(
+    NetworkChangeNotifier::NetworkHandle network,
+    const BoundNetLog& bound_net_log) {
+  // If migration_pending_ is false, there was no migration pending or
+  // an earlier task completed migration.
+  if (!migration_pending_)
+    return;
+
+  // TODO(jri): Ensure that OnSessionGoingAway is called consistently,
+  // and that it's always called at the same time in the whole
+  // migration process. Allows tests to be more uniform.
+  stream_factory_->OnSessionGoingAway(this);
+  stream_factory_->MigrateSessionToNewNetwork(
+      this, network, /*close_session_on_error=*/true, net_log_);
+}
+
 void QuicChromiumClientSession::OnWriteError(int error_code) {
   DCHECK_NE(ERR_IO_PENDING, error_code);
   DCHECK_GT(0, error_code);
   connection()->OnWriteError(error_code);
 }
 
 void QuicChromiumClientSession::OnWriteUnblocked() {
   connection()->OnCanWrite();
 }
 
@@ skipping 268 matching lines @@
 }
 
 void QuicChromiumClientSession::DeletePromised(
     QuicClientPromisedInfo* promised) {
   if (IsOpenStream(promised->id()))
     streams_pushed_and_claimed_count_++;
   QuicClientSessionBase::DeletePromised(promised);
 }
 
 }  // namespace net