Add Socket::ReadIfReady()

net/spdy/spdy_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/spdy/spdy_session.h"
 
 #include <algorithm>
 #include <limits>
 #include <map>
 #include <utility>
 
 #include "base/bind.h"
 #include "base/compiler_specific.h"
+#include "base/feature_list.h"
 #include "base/location.h"
 #include "base/logging.h"
 #include "base/memory/ptr_util.h"
 #include "base/metrics/histogram_macros.h"
 #include "base/metrics/sparse_histogram.h"
 #include "base/profiler/scoped_tracker.h"
 #include "base/single_thread_task_runner.h"
 #include "base/stl_util.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/string_util.h"
@@ skipping 14 matching lines @@
 #include "net/http/http_server_properties.h"
 #include "net/http/http_util.h"
 #include "net/http/transport_security_state.h"
 #include "net/log/net_log.h"
 #include "net/log/net_log_capture_mode.h"
 #include "net/log/net_log_event_type.h"
 #include "net/log/net_log_source.h"
 #include "net/log/net_log_source_type.h"
 #include "net/log/net_log_with_source.h"
 #include "net/proxy/proxy_server.h"
+#include "net/socket/socket.h"
 #include "net/socket/ssl_client_socket.h"
 #include "net/spdy/platform/api/spdy_estimate_memory_usage.h"
 #include "net/spdy/spdy_buffer_producer.h"
 #include "net/spdy/spdy_frame_builder.h"
 #include "net/spdy/spdy_http_utils.h"
 #include "net/spdy/spdy_protocol.h"
 #include "net/spdy/spdy_session_pool.h"
 #include "net/spdy/spdy_stream.h"
 #include "net/ssl/channel_id_service.h"
 #include "net/ssl/ssl_cipher_suite_names.h"
@@ skipping 1739 matching lines @@
 }
 
 void SpdySession::PumpReadLoop(ReadState expected_read_state, int result) {
   CHECK(!in_io_loop_);
   if (availability_state_ == STATE_DRAINING) {
     return;
   }
   ignore_result(DoReadLoop(expected_read_state, result));
 }
 
+int SpdySession::DoRead() {

[Bence, 2017/03/03 16:33:41]

Oh no, I just reordered methods in https://crrev.com/2683643002 so that the
order is consistent between spdy_session.h and spdy_session.cc.  If you want to
swap DoRead() and DoReadLoop(), could you please also do that in the header
file?

[xunjieli, 2017/03/03 19:41:06]

Done.

+  CHECK(in_io_loop_);
+
+  CHECK(connection_);
+  CHECK(connection_->socket());

[Bence, 2017/03/03 16:33:42]

Do you think this would flow more naturally?

if (base::FeatureList::IsEnabled(Socket::kReadIfReadyExperiment)) {
  int rv = connection_->socket()->ReadIfReady(
      read_buffer_.get(), kReadBufferSize,
      base::Bind(&SpdySession::PumpReadLoop, weak_factory_.GetWeakPtr(),
                 READ_STATE_DO_READ));
  // TODO(xunjieli): Follow-up CL to release |read_buffer_|.
  // https://crbug.com/524258
  if (rv == ERR_IO_PENDING) {
    read_state_ = READ_STATE_DO_READ;
    return rv;
  }
  if (rv != ERR_READ_IF_READY_NOT_IMPLEMENTED) {
    read_state_ = READ_STATE_DO_READ_COMPLETE;
    return rv;
  }
}
// Fallback to regular Read().
read_state_ = READ_STATE_DO_READ_COMPLETE;
return connection_->socket()->Read(
    read_buffer_.get(), kReadBufferSize,
    base::Bind(&SpdySession::PumpReadLoop, weak_factory_.GetWeakPtr(),
               READ_STATE_DO_READ_COMPLETE));

[xunjieli, 2017/03/03 19:41:06]

I may be biased, but I like my verson better. Fewer lines of code and the state
change is easier to read -- default to READ_STATE_DO_READ_COMPLETED but for
async ReadIfReady() case go to READ_STATE_DO_READ.

[Bence, 2017/03/06 23:43:14]

It's okay to be biased, you are the author.  :)

+  read_state_ = READ_STATE_DO_READ_COMPLETE;
+  int rv = ERR_READ_IF_READY_NOT_IMPLEMENTED;
+  if (base::FeatureList::IsEnabled(Socket::kReadIfReadyExperiment)) {
+    rv = connection_->socket()->ReadIfReady(
+        read_buffer_.get(), kReadBufferSize,
+        base::Bind(&SpdySession::PumpReadLoop, weak_factory_.GetWeakPtr(),
+                   READ_STATE_DO_READ));
+    // TODO(xunjieli): Follow-up CL to release |read_buffer_|. crbug.com/524258.

[Bence, 2017/03/03 16:33:42]

Optional: use https:// prefix for crbug, because some viewers/editors need that
to make this a clickable link (for example, gnome-terminal, when text is output
using cat, less, diff, grep etc.).

[xunjieli, 2017/03/03 19:41:06]

Done. I personally avoid the https:// prefix because that's extra 8 characters
and makes one line into two. 

[Bence, 2017/03/06 23:43:14]

I guess then you are not using vim in gnome-terminal to write code.  :)

+  }
+  if (rv == ERR_READ_IF_READY_NOT_IMPLEMENTED) {
+    // Fallback to regular Read().
+    return connection_->socket()->Read(
+        read_buffer_.get(), kReadBufferSize,
+        base::Bind(&SpdySession::PumpReadLoop, weak_factory_.GetWeakPtr(),
+                   READ_STATE_DO_READ_COMPLETE));
+  }
+  if (rv == ERR_IO_PENDING)
+    read_state_ = READ_STATE_DO_READ;
+  return rv;
+}
+
 int SpdySession::DoReadLoop(ReadState expected_read_state, int result) {
   CHECK(!in_io_loop_);
   CHECK_EQ(read_state_, expected_read_state);
 
   in_io_loop_ = true;
 
   int bytes_read_without_yielding = 0;
   const base::TimeTicks yield_after_time =
       time_func_() +
       base::TimeDelta::FromMilliseconds(kYieldAfterDurationMilliseconds);
@@ skipping 33 matching lines @@
       break;
     }
   }
 
   CHECK(in_io_loop_);
   in_io_loop_ = false;
 
   return result;
 }
 
-int SpdySession::DoRead() {
-  CHECK(in_io_loop_);
-
-  CHECK(connection_);
-  CHECK(connection_->socket());
-  read_state_ = READ_STATE_DO_READ_COMPLETE;
-  return connection_->socket()->Read(
-      read_buffer_.get(), kReadBufferSize,
-      base::Bind(&SpdySession::PumpReadLoop, weak_factory_.GetWeakPtr(),
-                 READ_STATE_DO_READ_COMPLETE));
-}
-
 int SpdySession::DoReadComplete(int result) {
   CHECK(in_io_loop_);
 
   // Parse a frame.  For now this code requires that the frame fit into our
   // buffer (kReadBufferSize).
   // TODO(mbelshe): support arbitrarily large frames!
 
   if (result == 0) {
     DoDrainSession(ERR_CONNECTION_CLOSED, "Connection closed");
     return ERR_CONNECTION_CLOSED;
@@ skipping 1276 matching lines @@
     if (!queue->empty()) {
       SpdyStreamId stream_id = queue->front();
       queue->pop_front();
       return stream_id;
     }
   }
   return 0;
 }
 
 }  // namespace net