JobController 2: Remove reference between HttpStreamFactoryImpl::Jobs.

net/http/http_stream_factory_impl_job.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/http/http_stream_factory_impl_job.h"
 
 #include <algorithm>
 #include <string>
 #include <utility>
 
@@ skipping 138 matching lines @@
     NetLogCaptureMode /* capture_mode */) {
   std::unique_ptr<base::DictionaryValue> dict(new base::DictionaryValue());
 
   dict->SetString("next_proto_status",
                   SSLClientSocket::NextProtoStatusToString(status));
   dict->SetString("proto", *proto);
   return std::move(dict);
 }
 
 HttpStreamFactoryImpl::Job::Job(JobController* job_controller,
+                                JobType job_type,
                                 HttpNetworkSession* session,
                                 const HttpRequestInfo& request_info,
                                 RequestPriority priority,
                                 const SSLConfig& server_ssl_config,
                                 const SSLConfig& proxy_ssl_config,
                                 HostPortPair destination,
                                 GURL origin_url,
                                 NetLog* net_log)
     : Job(job_controller,
+          job_type,
           session,
           request_info,
           priority,
           server_ssl_config,
           proxy_ssl_config,
           destination,
           origin_url,
           AlternativeService(),
           net_log) {}
 
 HttpStreamFactoryImpl::Job::Job(JobController* job_controller,
+                                JobType job_type,
                                 HttpNetworkSession* session,
                                 const HttpRequestInfo& request_info,
                                 RequestPriority priority,
                                 const SSLConfig& server_ssl_config,
                                 const SSLConfig& proxy_ssl_config,
                                 HostPortPair destination,
                                 GURL origin_url,
                                 AlternativeService alternative_service,
                                 NetLog* net_log)
     : request_info_(request_info),
       priority_(priority),
       server_ssl_config_(server_ssl_config),
       proxy_ssl_config_(proxy_ssl_config),
       net_log_(BoundNetLog::Make(net_log, NetLog::SOURCE_HTTP_STREAM_JOB)),
       io_callback_(base::Bind(&Job::OnIOComplete, base::Unretained(this))),
       connection_(new ClientSocketHandle),
       session_(session),
       next_state_(STATE_NONE),
       pac_request_(NULL),
       destination_(destination),
       origin_url_(origin_url),
       alternative_service_(alternative_service),
       job_controller_(job_controller),
-      blocking_job_(NULL),
-      waiting_job_(NULL),
+      job_type_(job_type),
       orphaned_(false),
       using_ssl_(false),
       using_spdy_(false),
       using_quic_(false),
       quic_request_(session_->quic_stream_factory()),
       using_existing_quic_session_(false),
       spdy_certificate_error_(OK),
       establishing_tunnel_(false),
       was_npn_negotiated_(false),
       protocol_negotiated_(kProtoUnknown),
       num_streams_(0),
       spdy_session_direct_(false),
       job_status_(STATUS_RUNNING),
       other_job_status_(STATUS_RUNNING),
       stream_type_(HttpStreamRequest::BIDIRECTIONAL_STREAM),
       ptr_factory_(this) {
   DCHECK(session);
   if (IsQuicAlternative()) {
     DCHECK(session_->params().enable_quic);
     using_quic_ = true;
   }
 }
 
 HttpStreamFactoryImpl::Job::~Job() {
   net_log_.EndEvent(NetLog::TYPE_HTTP_STREAM_JOB);
+  job_controller_->OnJobDeletion(this);

[Ryan Hamilton, 2016/05/06 21:33:14]

The controller owns the job, right? That means the controller is deleting the
job. So that seems to suggest that the controller already knows that the job is
being deleted.

[Zhongyi Shi, 2016/05/13 00:31:25]

The intention was to remove references to the deleted Job. But since we had
fewer ref (just bound_job_), yeah, we don't need this anymore. 

 
   // When we're in a partially constructed state, waiting for the user to
   // provide certificate handling information or authentication, we can't reuse
   // this stream at all.
   if (next_state_ == STATE_WAITING_USER_ACTION) {
     connection_->socket()->Disconnect();
     connection_.reset();
   }
 
   if (pac_request_)
@@ skipping 37 matching lines @@
     case STATE_RESOLVE_PROXY_COMPLETE:
       return session_->proxy_service()->GetLoadState(pac_request_);
     case STATE_INIT_CONNECTION_COMPLETE:
     case STATE_CREATE_STREAM_COMPLETE:
       return using_quic_ ? LOAD_STATE_CONNECTING : connection_->GetLoadState();
     default:
       return LOAD_STATE_IDLE;
   }
 }
 
-void HttpStreamFactoryImpl::Job::WaitFor(Job* job) {
-  DCHECK_EQ(STATE_NONE, next_state_);
-  DCHECK_EQ(STATE_NONE, job->next_state_);
-  DCHECK(!blocking_job_);
-  DCHECK(!job->waiting_job_);
-
-  // Never share connection with other jobs for FTP requests.
-  DCHECK(!request_info_.url.SchemeIs("ftp"));
-
-  blocking_job_ = job;
-  job->waiting_job_ = this;
-}
-
 void HttpStreamFactoryImpl::Job::ResumeAfterDelay() {
-  DCHECK(!blocking_job_);
+  DCHECK((job_type_ == ALTERNATIVE || !job_controller_->racing()));
   DCHECK_EQ(STATE_WAIT_FOR_JOB_COMPLETE, next_state_);
 
   net_log_.AddEvent(NetLog::TYPE_HTTP_STREAM_JOB_DELAYED,
                     base::Bind(&NetLogHttpStreamJobDelayCallback, wait_time_));
   base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
       FROM_HERE, base::Bind(&HttpStreamFactoryImpl::Job::OnIOComplete,
                             ptr_factory_.GetWeakPtr(), OK),
       wait_time_);
 }
 
-void HttpStreamFactoryImpl::Job::Resume(Job* job,
-                                        const base::TimeDelta& delay) {
-  DCHECK_EQ(blocking_job_, job);
-  blocking_job_ = NULL;
-
+void HttpStreamFactoryImpl::Job::Resume(const base::TimeDelta& delay) {
   // If |this| job is not past STATE_WAIT_FOR_JOB_COMPLETE state, then it will
   // be delayed by the |wait_time_| when it resumes.
   if (next_state_ == STATE_NONE || next_state_ <= STATE_WAIT_FOR_JOB_COMPLETE)
     wait_time_ = delay;
 
   // We know we're blocked if the next_state_ is STATE_WAIT_FOR_JOB_COMPLETE.
   // Unblock |this|.
   if (next_state_ == STATE_WAIT_FOR_JOB_COMPLETE)
     ResumeAfterDelay();
 }
 
 void HttpStreamFactoryImpl::Job::Orphan(const Request* request) {
   DCHECK(!orphaned_);
   if (!IsPreconnecting())
     orphaned_ = true;
   net_log_.AddEvent(NetLog::TYPE_HTTP_STREAM_JOB_ORPHANED);
-  if (blocking_job_) {
-    // We've been orphaned, but there's a job we're blocked on. Don't bother
-    // racing, just cancel ourself.
-    DCHECK(blocking_job_->waiting_job_);
-    blocking_job_->waiting_job_ = NULL;
-    blocking_job_ = NULL;
-    if (job_controller_->for_websockets() && connection_ &&
-        connection_->socket()) {
-      connection_->socket()->Disconnect();
-    }
-    job_controller_->OnOrphanedJobComplete(this);
-  } else if (job_controller_->for_websockets()) {
+
+  job_controller_->MaybeResumeOtherJob(this, base::TimeDelta());
+  if (job_controller_->for_websockets()) {
     // We cancel this job because a WebSocketHandshakeStream can't be created
     // without a WebSocketHandshakeStreamBase::CreateHelper which is stored in
     // the Request class and isn't accessible from this job.
     if (connection_ && connection_->socket()) {
       connection_->socket()->Disconnect();
     }
     job_controller_->OnOrphanedJobComplete(this);
   }
 }
 
@@ skipping 249 matching lines @@
 }
 
 int HttpStreamFactoryImpl::Job::RunLoop(int result) {
   TRACE_EVENT0(TRACE_DISABLED_BY_DEFAULT("net"),
                "HttpStreamFactoryImpl::Job::RunLoop");
   result = DoLoop(result);
 
   if (result == ERR_IO_PENDING)
     return result;
 
-  // If there was an error, we should have already resumed the |waiting_job_|,
-  // if there was one.
-  DCHECK(result == OK || waiting_job_ == NULL);
+  // If there was an error, we should have already resumed the other waiting
+  // job, if there was one.
+  DCHECK(result == OK || job_type_ == NON_ALTERNATIVE ||
+         !job_controller_->racing());
 
   if (IsPreconnecting()) {
     base::ThreadTaskRunnerHandle::Get()->PostTask(
         FROM_HERE,
         base::Bind(&HttpStreamFactoryImpl::Job::OnPreconnectsComplete,
                    ptr_factory_.GetWeakPtr()));
     return ERR_IO_PENDING;
   }
 
   if (IsCertificateError(result)) {
@@ skipping 183 matching lines @@
                  priority_));
   if (!IsPreconnecting() && !orphaned_) {
     job_controller_->GetNetLogFromRequest().AddEvent(
         NetLog::TYPE_HTTP_STREAM_REQUEST_STARTED_JOB,
         net_log_.source().ToEventParametersCallback());
   }
 
   // Don't connect to restricted ports.
   if (!IsPortAllowedForScheme(destination_.port(),
                               request_info_.url.scheme())) {
-    if (waiting_job_) {
-      waiting_job_->Resume(this, base::TimeDelta());
-      waiting_job_ = NULL;
-    }
+    job_controller_->MaybeResumeOtherJob(this, base::TimeDelta());
     return ERR_UNSAFE_PORT;
   }
 
   next_state_ = STATE_RESOLVE_PROXY;
   return OK;
 }
 
 int HttpStreamFactoryImpl::Job::DoResolveProxy() {
   DCHECK(!pac_request_);
   DCHECK(session_);
@@ skipping 52 matching lines @@
       result = ERR_NO_SUPPORTED_PROXIES;
     } else if (using_quic_ &&
                (!proxy_info_.is_quic() && !proxy_info_.is_direct())) {
       // QUIC can not be spoken to non-QUIC proxies.  This error should not be
       // user visible, because the non-alternative Job should be resumed.
       result = ERR_NO_SUPPORTED_PROXIES;
     }
   }
 
   if (result != OK) {
-    if (waiting_job_) {
-      waiting_job_->Resume(this, base::TimeDelta());
-      waiting_job_ = NULL;
-    }
+    job_controller_->MaybeResumeOtherJob(this, base::TimeDelta());
     return result;
   }
 
   next_state_ = STATE_WAIT_FOR_JOB;
   return OK;
 }
 
 bool HttpStreamFactoryImpl::Job::ShouldForceQuic() const {
   return session_->params().enable_quic &&
          ContainsKey(session_->params().origins_to_force_quic_on,
                      destination_) &&
          proxy_info_.is_direct() && origin_url_.SchemeIs("https");
 }
 
 int HttpStreamFactoryImpl::Job::DoWaitForJob() {
-  if (!blocking_job_ && wait_time_.is_zero()) {
-    // There is no |blocking_job_| and there is no |wait_time_|.
+  if ((job_type_ == ALTERNATIVE || !job_controller_->racing()) &&
+      wait_time_.is_zero()) {
+    // There is no blocking job and there is no |wait_time_|.
     next_state_ = STATE_INIT_CONNECTION;
     return OK;
   }
 
   next_state_ = STATE_WAIT_FOR_JOB_COMPLETE;
   if (!wait_time_.is_zero()) {
     // If there is a waiting_time, then resume the job after the wait_time_.
-    DCHECK(!blocking_job_);
+    DCHECK((job_type_ == ALTERNATIVE || !job_controller_->racing()));

[Ryan Hamilton, 2016/05/06 21:33:14]

it's not clear to me why the job needs to perform this check since this seems
like the responsibility of the controller.

[Zhongyi Shi, 2016/05/13 00:31:24]

Moved to JobController!

     ResumeAfterDelay();
   }
 
   return ERR_IO_PENDING;
 }
 
 int HttpStreamFactoryImpl::Job::DoWaitForJobComplete(int result) {
-  DCHECK(!blocking_job_);
+  DCHECK((job_type_ == ALTERNATIVE || !job_controller_->racing()));
   DCHECK_EQ(OK, result);
   wait_time_ = base::TimeDelta();
   next_state_ = STATE_INIT_CONNECTION;
   return OK;
 }
 
 int HttpStreamFactoryImpl::Job::DoInitConnection() {
   // TODO(pkasting): Remove ScopedTracker below once crbug.com/462812 is fixed.
   tracked_objects::ScopedTracker tracking_profile(
       FROM_HERE_WITH_EXPLICIT_FUNCTION(
           "462812 HttpStreamFactoryImpl::Job::DoInitConnection"));
-  DCHECK(!blocking_job_);
+  DCHECK((job_type_ == ALTERNATIVE || !job_controller_->racing()));
   DCHECK(!connection_->is_initialized());
   DCHECK(proxy_info_.proxy_server().is_valid());
   next_state_ = STATE_INIT_CONNECTION_COMPLETE;
 
   using_ssl_ = origin_url_.SchemeIs("https") || origin_url_.SchemeIs("wss") ||
                IsSpdyAlternative();
   using_spdy_ = false;
 
   if (ShouldForceQuic())
     using_quic_ = true;
@@ skipping 51 matching lines @@
       destination = destination_;
       ssl_config = &server_ssl_config_;
     }
     int rv =
         quic_request_.Request(destination, request_info_.privacy_mode,
                               ssl_config->GetCertVerifyFlags(), url,
                               request_info_.method, net_log_, io_callback_);
     if (rv == OK) {
       using_existing_quic_session_ = true;
     } else {
-      // OK, there's no available QUIC session. Let |waiting_job_| resume
-      // if it's paused.
-      if (waiting_job_) {
-        if (rv == ERR_IO_PENDING) {
-          // Start the |waiting_job_| after the delay returned by
-          // GetTimeDelayForWaitingJob().
-          //
-          // If QUIC request fails during handshake, then
-          // DoInitConnectionComplete() will start the |waiting_job_|.
-          waiting_job_->Resume(this, quic_request_.GetTimeDelayForWaitingJob());
-        } else {
-          // QUIC request has failed, resume the |waiting_job_|.
-          waiting_job_->Resume(this, base::TimeDelta());
-        }
-        waiting_job_ = NULL;
+      base::TimeDelta delay = base::TimeDelta();

[Ryan Hamilton, 2016/05/06 21:33:14]

nit: I think you can remove the = ...;

[Zhongyi Shi, 2016/05/13 00:31:24]

Done.

+      // OK, there's no available QUIC session. Let JobController to resume
+      // the waiting job if it's paused.
+      if (rv == ERR_IO_PENDING) {
+        // Start the waiting job after the delay returned by
+        // GetTimeDelayForWaitingJob().
+        //
+        // If QUIC request fails during handshake, then
+        // DoInitConnectionComplete() will start the waiting job.
+        delay = quic_request_.GetTimeDelayForWaitingJob();
       }
+      job_controller_->MaybeResumeOtherJob(this, delay);
     }
     return rv;
   }
 
   SpdySessionKey spdy_session_key = GetSpdySessionKey();
 
   // Check first if we have a spdy session for this group.  If so, then go
   // straight to using that.
   if (CanUseExistingSpdySession()) {
     base::WeakPtr<SpdySession> spdy_session;
@@ skipping 11 matching lines @@
       existing_spdy_session_ = spdy_session;
       return OK;
     }
   }
   if (!IsPreconnecting() && !orphaned_ && using_ssl_) {
     // Ask |job_controller_| to update the spdy session key for the request
     // that launched this job.
     job_controller_->SetSpdySessionKey(spdy_session_key);
   }
 
-  // OK, there's no available SPDY session. Let |waiting_job_| resume if it's
-  // paused.
-  if (waiting_job_) {
-    waiting_job_->Resume(this, base::TimeDelta());
-    waiting_job_ = NULL;
-  }
+  // OK, there's no available SPDY session. Let JobController to resume the
+  // non-alternative job if it's paused.
+  job_controller_->MaybeResumeOtherJob(this, base::TimeDelta());
 
   if (proxy_info_.is_http() || proxy_info_.is_https())
     establishing_tunnel_ = using_ssl_;
 
   const bool expect_spdy = IsSpdyAlternative();
 
   base::WeakPtr<HttpServerProperties> http_server_properties =
       session_->http_server_properties();
   if (http_server_properties) {
     http_server_properties->MaybeForceHTTP11(destination_, &server_ssl_config_);
@@ skipping 33 matching lines @@
   }
 
   return InitSocketHandleForHttpRequest(
       GetSocketGroup(), destination_, request_info_.extra_headers,
       request_info_.load_flags, priority_, session_, proxy_info_, expect_spdy,
       server_ssl_config_, proxy_ssl_config_, request_info_.privacy_mode,
       net_log_, connection_.get(), resolution_callback, io_callback_);
 }
 
 int HttpStreamFactoryImpl::Job::DoInitConnectionComplete(int result) {
-  if (using_quic_ && result < 0 && waiting_job_) {
-    waiting_job_->Resume(this, base::TimeDelta());
-    waiting_job_ = NULL;
+  if (using_quic_ && result < 0) {
+    job_controller_->MaybeResumeOtherJob(this, base::TimeDelta());
   }
   if (IsPreconnecting()) {
     if (using_quic_)
       return result;
     DCHECK_EQ(OK, result);
     return OK;
   }
 
   if (result == ERR_SPDY_SESSION_ALREADY_EXISTS) {
     // We found a SPDY connection after resolving the host.  This is
@@ skipping 17 matching lines @@
     // Underlying QUIC layer would have closed the connection.
     HostPortPair destination = proxy_info_.proxy_server().host_port_pair();
     if (session_->quic_stream_factory()->IsQuicDisabled(destination.port())) {
       using_quic_ = false;
       return ReconsiderProxyAfterError(ERR_QUIC_PROTOCOL_ERROR);
     }
   }
 
   // TODO(willchan): Make this a bit more exact. Maybe there are recoverable
   // errors, such as ignoring certificate errors for Alternate-Protocol.
-  if (result < 0 && waiting_job_) {
-    waiting_job_->Resume(this, base::TimeDelta());
-    waiting_job_ = NULL;
+  if (result < 0) {
+    job_controller_->MaybeResumeOtherJob(this, base::TimeDelta());
   }
 
   // |result| may be the result of any of the stacked pools. The following
   // logic is used when determining how to interpret an error.
   // If |result| < 0:
   //   and connection_->socket() != NULL, then the SSL handshake ran and it
   //     is a potentially recoverable error.
   //   and connection_->socket == NULL and connection_->is_ssl_error() is true,
   //     then the SSL handshake ran with an unrecoverable error.
   //   otherwise, the error came from one of the other pools.
@@ skipping 631 matching lines @@
     ConnectionAttempts socket_attempts;
     connection_->socket()->GetConnectionAttempts(&socket_attempts);
     job_controller_->AddConnectionAttemptsToRequest(socket_attempts);
   } else {
     job_controller_->AddConnectionAttemptsToRequest(
         connection_->connection_attempts());
   }
 }
 
 }  // namespace net