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 #ifndef NET_SPDY_SPDY_SESSION_H_
6 #define NET_SPDY_SPDY_SESSION_H_
13 #include "base/basictypes.h"
14 #include "base/gtest_prod_util.h"
15 #include "base/memory/ref_counted.h"
16 #include "base/memory/scoped_ptr.h"
17 #include "base/memory/weak_ptr.h"
18 #include "base/time/time.h"
19 #include "net/base/io_buffer.h"
20 #include "net/base/load_states.h"
21 #include "net/base/net_errors.h"
22 #include "net/base/net_export.h"
23 #include "net/base/request_priority.h"
24 #include "net/socket/client_socket_handle.h"
25 #include "net/socket/client_socket_pool.h"
26 #include "net/socket/next_proto.h"
27 #include "net/socket/ssl_client_socket.h"
28 #include "net/socket/stream_socket.h"
29 #include "net/spdy/buffered_spdy_framer.h"
30 #include "net/spdy/spdy_buffer.h"
31 #include "net/spdy/spdy_framer.h"
32 #include "net/spdy/spdy_header_block.h"
33 #include "net/spdy/spdy_protocol.h"
34 #include "net/spdy/spdy_session_pool.h"
35 #include "net/spdy/spdy_stream.h"
36 #include "net/spdy/spdy_write_queue.h"
37 #include "net/ssl/ssl_config_service.h"
42 // This is somewhat arbitrary and not really fixed, but it will always work
43 // reasonably with ethernet. Chop the world into 2-packet chunks. This is
44 // somewhat arbitrary, but is reasonably small and ensures that we elicit
45 // ACKs quickly from TCP (because TCP tries to only ACK every other packet).
46 const int kMss
= 1430;
47 // The 8 is the size of the SPDY frame header.
48 const int kMaxSpdyFrameChunkSize
= (2 * kMss
) - 8;
50 // Maximum number of concurrent streams we will create, unless the server
51 // sends a SETTINGS frame with a different value.
52 const size_t kInitialMaxConcurrentStreams
= 100;
54 // Specifies the maxiumum concurrent streams server could send (via push).
55 const int kMaxConcurrentPushedStreams
= 1000;
57 // Specifies the maximum number of bytes to read synchronously before
59 const int kMaxReadBytesWithoutYielding
= 32 * 1024;
61 // First and last valid stream IDs. As we always act as the client,
62 // start at 1 for the first stream id.
63 const SpdyStreamId kFirstStreamId
= 1;
64 const SpdyStreamId kLastStreamId
= 0x7fffffff;
67 struct LoadTimingInfo
;
70 class TransportSecurityState
;
72 // NOTE: There's an enum of the same name (also with numeric suffixes)
73 // in histograms.xml. Be sure to add new values there also.
74 enum SpdyProtocolErrorDetails
{
75 // SpdyFramer::SpdyError mappings.
76 SPDY_ERROR_NO_ERROR
= 0,
77 SPDY_ERROR_INVALID_CONTROL_FRAME
= 1,
78 SPDY_ERROR_CONTROL_PAYLOAD_TOO_LARGE
= 2,
79 SPDY_ERROR_ZLIB_INIT_FAILURE
= 3,
80 SPDY_ERROR_UNSUPPORTED_VERSION
= 4,
81 SPDY_ERROR_DECOMPRESS_FAILURE
= 5,
82 SPDY_ERROR_COMPRESS_FAILURE
= 6,
83 // SPDY_ERROR_CREDENTIAL_FRAME_CORRUPT = 7, (removed).
84 SPDY_ERROR_GOAWAY_FRAME_CORRUPT
= 29,
85 SPDY_ERROR_RST_STREAM_FRAME_CORRUPT
= 30,
86 SPDY_ERROR_INVALID_DATA_FRAME_FLAGS
= 8,
87 SPDY_ERROR_INVALID_CONTROL_FRAME_FLAGS
= 9,
88 SPDY_ERROR_UNEXPECTED_FRAME
= 31,
89 // SpdyRstStreamStatus mappings.
90 // RST_STREAM_INVALID not mapped.
91 STATUS_CODE_PROTOCOL_ERROR
= 11,
92 STATUS_CODE_INVALID_STREAM
= 12,
93 STATUS_CODE_REFUSED_STREAM
= 13,
94 STATUS_CODE_UNSUPPORTED_VERSION
= 14,
95 STATUS_CODE_CANCEL
= 15,
96 STATUS_CODE_INTERNAL_ERROR
= 16,
97 STATUS_CODE_FLOW_CONTROL_ERROR
= 17,
98 STATUS_CODE_STREAM_IN_USE
= 18,
99 STATUS_CODE_STREAM_ALREADY_CLOSED
= 19,
100 STATUS_CODE_INVALID_CREDENTIALS
= 20,
101 STATUS_CODE_FRAME_SIZE_ERROR
= 21,
102 STATUS_CODE_SETTINGS_TIMEOUT
= 32,
103 STATUS_CODE_CONNECT_ERROR
= 33,
104 STATUS_CODE_ENHANCE_YOUR_CALM
= 34,
105 STATUS_CODE_INADEQUATE_SECURITY
= 35,
106 STATUS_CODE_HTTP_1_1_REQUIRED
= 36,
108 // SpdySession errors
109 PROTOCOL_ERROR_UNEXPECTED_PING
= 22,
110 PROTOCOL_ERROR_RST_STREAM_FOR_NON_ACTIVE_STREAM
= 23,
111 PROTOCOL_ERROR_SPDY_COMPRESSION_FAILURE
= 24,
112 PROTOCOL_ERROR_REQUEST_FOR_SECURE_CONTENT_OVER_INSECURE_SESSION
= 25,
113 PROTOCOL_ERROR_SYN_REPLY_NOT_RECEIVED
= 26,
114 PROTOCOL_ERROR_INVALID_WINDOW_UPDATE_SIZE
= 27,
115 PROTOCOL_ERROR_RECEIVE_WINDOW_VIOLATION
= 28,
118 NUM_SPDY_PROTOCOL_ERROR_DETAILS
= 37,
120 SpdyProtocolErrorDetails NET_EXPORT_PRIVATE
121 MapFramerErrorToProtocolError(SpdyFramer::SpdyError error
);
122 Error NET_EXPORT_PRIVATE
MapFramerErrorToNetError(SpdyFramer::SpdyError error
);
123 SpdyProtocolErrorDetails NET_EXPORT_PRIVATE
124 MapRstStreamStatusToProtocolError(SpdyRstStreamStatus status
);
125 SpdyGoAwayStatus NET_EXPORT_PRIVATE
MapNetErrorToGoAwayStatus(Error err
);
127 // If these compile asserts fail then SpdyProtocolErrorDetails needs
128 // to be updated with new values, as do the mapping functions above.
129 static_assert(12 == SpdyFramer::LAST_ERROR
,
130 "SpdyProtocolErrorDetails / Spdy Errors mismatch");
131 static_assert(17 == RST_STREAM_NUM_STATUS_CODES
,
132 "SpdyProtocolErrorDetails / RstStreamStatus mismatch");
134 // Splits pushed |headers| into request and response parts. Request headers are
135 // the headers specifying resource URL.
136 void NET_EXPORT_PRIVATE
137 SplitPushedHeadersToRequestAndResponse(const SpdyHeaderBlock
& headers
,
138 SpdyMajorVersion protocol_version
,
139 SpdyHeaderBlock
* request_headers
,
140 SpdyHeaderBlock
* response_headers
);
142 // A helper class used to manage a request to create a stream.
143 class NET_EXPORT_PRIVATE SpdyStreamRequest
{
146 // Calls CancelRequest().
147 ~SpdyStreamRequest();
149 // Starts the request to create a stream. If OK is returned, then
150 // ReleaseStream() may be called. If ERR_IO_PENDING is returned,
151 // then when the stream is created, |callback| will be called, at
152 // which point ReleaseStream() may be called. Otherwise, the stream
153 // is not created, an error is returned, and ReleaseStream() may not
156 // If OK is returned, must not be called again without
157 // ReleaseStream() being called first. If ERR_IO_PENDING is
158 // returned, must not be called again without CancelRequest() or
159 // ReleaseStream() being called first. Otherwise, in case of an
160 // immediate error, this may be called again.
161 int StartRequest(SpdyStreamType type
,
162 const base::WeakPtr
<SpdySession
>& session
,
164 RequestPriority priority
,
165 const BoundNetLog
& net_log
,
166 const CompletionCallback
& callback
);
168 // Cancels any pending stream creation request. May be called
170 void CancelRequest();
172 // Transfers the created stream (guaranteed to not be NULL) to the
173 // caller. Must be called at most once after StartRequest() returns
174 // OK or |callback| is called with OK. The caller must immediately
175 // set a delegate for the returned stream (except for test code).
176 base::WeakPtr
<SpdyStream
> ReleaseStream();
179 friend class SpdySession
;
181 // Called by |session_| when the stream attempt has finished
183 void OnRequestCompleteSuccess(const base::WeakPtr
<SpdyStream
>& stream
);
185 // Called by |session_| when the stream attempt has finished with an
186 // error. Also called with ERR_ABORTED if |session_| is destroyed
187 // while the stream attempt is still pending.
188 void OnRequestCompleteFailure(int rv
);
190 // Accessors called by |session_|.
191 SpdyStreamType
type() const { return type_
; }
192 const GURL
& url() const { return url_
; }
193 RequestPriority
priority() const { return priority_
; }
194 const BoundNetLog
& net_log() const { return net_log_
; }
198 SpdyStreamType type_
;
199 base::WeakPtr
<SpdySession
> session_
;
200 base::WeakPtr
<SpdyStream
> stream_
;
202 RequestPriority priority_
;
203 BoundNetLog net_log_
;
204 CompletionCallback callback_
;
206 base::WeakPtrFactory
<SpdyStreamRequest
> weak_ptr_factory_
;
208 DISALLOW_COPY_AND_ASSIGN(SpdyStreamRequest
);
211 class NET_EXPORT SpdySession
: public BufferedSpdyFramerVisitorInterface
,
212 public SpdyFramerDebugVisitorInterface
,
213 public HigherLayeredPool
{
215 // TODO(akalin): Use base::TickClock when it becomes available.
216 typedef base::TimeTicks (*TimeFunc
)(void);
218 // How we handle flow control (version-dependent).
219 enum FlowControlState
{
222 FLOW_CONTROL_STREAM_AND_SESSION
225 // Returns true if |hostname| can be pooled into an existing connection
226 // associated with |ssl_info|.
227 static bool CanPool(TransportSecurityState
* transport_security_state
,
228 const SSLInfo
& ssl_info
,
229 const std::string
& old_hostname
,
230 const std::string
& new_hostname
);
232 // Create a new SpdySession.
233 // |spdy_session_key| is the host/port that this session connects to, privacy
234 // and proxy configuration settings that it's using.
235 // |session| is the HttpNetworkSession. |net_log| is the NetLog that we log
236 // network events to.
237 SpdySession(const SpdySessionKey
& spdy_session_key
,
238 const base::WeakPtr
<HttpServerProperties
>& http_server_properties
,
239 TransportSecurityState
* transport_security_state
,
240 bool verify_domain_authentication
,
241 bool enable_sending_initial_data
,
242 bool enable_compression
,
243 bool enable_ping_based_connection_checking
,
244 NextProto default_protocol
,
245 size_t session_max_recv_window_size
,
246 size_t stream_max_recv_window_size
,
247 size_t initial_max_concurrent_streams
,
248 size_t max_concurrent_streams_limit
,
250 const HostPortPair
& trusted_spdy_proxy
,
253 ~SpdySession() override
;
255 const HostPortPair
& host_port_pair() const {
256 return spdy_session_key_
.host_port_proxy_pair().first
;
258 const HostPortProxyPair
& host_port_proxy_pair() const {
259 return spdy_session_key_
.host_port_proxy_pair();
261 const SpdySessionKey
& spdy_session_key() const {
262 return spdy_session_key_
;
264 // Get a pushed stream for a given |url|. If the server initiates a
265 // stream, it might already exist for a given path. The server
266 // might also not have initiated the stream yet, but indicated it
267 // will via X-Associated-Content. Returns OK if a stream was found
268 // and put into |spdy_stream|, or if one was not found but it is
269 // okay to create a new stream (in which case |spdy_stream| is
270 // reset). Returns an error (not ERR_IO_PENDING) otherwise, and
271 // resets |spdy_stream|.
274 base::WeakPtr
<SpdyStream
>* spdy_stream
,
275 const BoundNetLog
& stream_net_log
);
277 // Initialize the session with the given connection. |is_secure|
278 // must indicate whether |connection| uses an SSL socket or not; it
279 // is usually true, but it can be false for testing or when SPDY is
280 // configured to work with non-secure sockets.
282 // |pool| is the SpdySessionPool that owns us. Its lifetime must
283 // strictly be greater than |this|.
285 // |certificate_error_code| must either be OK or less than
288 // The session begins reading from |connection| on a subsequent event loop
289 // iteration, so the SpdySession may close immediately afterwards if the first
290 // read of |connection| fails.
291 void InitializeWithSocket(scoped_ptr
<ClientSocketHandle
> connection
,
292 SpdySessionPool
* pool
,
294 int certificate_error_code
);
296 // Returns the protocol used by this session. Always between
297 // kProtoSPDYMinimumVersion and kProtoSPDYMaximumVersion.
298 NextProto
protocol() const { return protocol_
; }
300 // Check to see if this SPDY session can support an additional domain.
301 // If the session is un-authenticated, then this call always returns true.
302 // For SSL-based sessions, verifies that the server certificate in use by
303 // this session provides authentication for the domain and no client
304 // certificate or channel ID was sent to the original server during the SSL
305 // handshake. NOTE: This function can have false negatives on some
307 // TODO(wtc): rename this function and the Net.SpdyIPPoolDomainMatch
308 // histogram because this function does more than verifying domain
309 // authentication now.
310 bool VerifyDomainAuthentication(const std::string
& domain
);
312 // Pushes the given producer into the write queue for
313 // |stream|. |stream| is guaranteed to be activated before the
314 // producer is used to produce its frame.
315 void EnqueueStreamWrite(const base::WeakPtr
<SpdyStream
>& stream
,
316 SpdyFrameType frame_type
,
317 scoped_ptr
<SpdyBufferProducer
> producer
);
319 // Creates and returns a SYN frame for |stream_id|.
320 scoped_ptr
<SpdyFrame
> CreateSynStream(
321 SpdyStreamId stream_id
,
322 RequestPriority priority
,
323 SpdyControlFlags flags
,
324 const SpdyHeaderBlock
& headers
);
326 // Creates and returns a SpdyBuffer holding a data frame with the
327 // given data. May return NULL if stalled by flow control.
328 scoped_ptr
<SpdyBuffer
> CreateDataBuffer(SpdyStreamId stream_id
,
331 SpdyDataFlags flags
);
333 // Close the stream with the given ID, which must exist and be
334 // active. Note that that stream may hold the last reference to the
336 void CloseActiveStream(SpdyStreamId stream_id
, int status
);
338 // Close the given created stream, which must exist but not yet be
339 // active. Note that |stream| may hold the last reference to the
341 void CloseCreatedStream(const base::WeakPtr
<SpdyStream
>& stream
, int status
);
343 // Send a RST_STREAM frame with the given status code and close the
344 // stream with the given ID, which must exist and be active. Note
345 // that that stream may hold the last reference to the session.
346 void ResetStream(SpdyStreamId stream_id
,
347 SpdyRstStreamStatus status
,
348 const std::string
& description
);
350 // Check if a stream is active.
351 bool IsStreamActive(SpdyStreamId stream_id
) const;
353 // The LoadState is used for informing the user of the current network
354 // status, such as "resolving host", "connecting", etc.
355 LoadState
GetLoadState() const;
357 // Fills SSL info in |ssl_info| and returns true when SSL is in use.
358 bool GetSSLInfo(SSLInfo
* ssl_info
,
359 bool* was_npn_negotiated
,
360 NextProto
* protocol_negotiated
);
362 // Fills SSL Certificate Request info |cert_request_info| and returns
363 // true when SSL is in use.
364 bool GetSSLCertRequestInfo(SSLCertRequestInfo
* cert_request_info
);
366 // Send a WINDOW_UPDATE frame for a stream. Called by a stream
367 // whenever receive window size is increased.
368 void SendStreamWindowUpdate(SpdyStreamId stream_id
,
369 uint32 delta_window_size
);
371 // Accessors for the session's availability state.
372 bool IsAvailable() const { return availability_state_
== STATE_AVAILABLE
; }
373 bool IsGoingAway() const { return availability_state_
== STATE_GOING_AWAY
; }
374 bool IsDraining() const { return availability_state_
== STATE_DRAINING
; }
376 // Closes this session. This will close all active streams and mark
377 // the session as permanently closed. Callers must assume that the
378 // session is destroyed after this is called. (However, it may not
379 // be destroyed right away, e.g. when a SpdySession function is
380 // present in the call stack.)
382 // |err| should be < ERR_IO_PENDING; this function is intended to be
384 // |description| indicates the reason for the error.
385 void CloseSessionOnError(Error err
, const std::string
& description
);
387 // Mark this session as unavailable, meaning that it will not be used to
388 // service new streams. Unlike when a GOAWAY frame is received, this function
389 // will not close any streams.
390 void MakeUnavailable();
392 // Closes all active streams with stream id's greater than
393 // |last_good_stream_id|, as well as any created or pending
394 // streams. Must be called only when |availability_state_| >=
395 // STATE_GOING_AWAY. After this function, DcheckGoingAway() will
396 // pass. May be called multiple times.
397 void StartGoingAway(SpdyStreamId last_good_stream_id
, Error status
);
399 // Must be called only when going away (i.e., DcheckGoingAway()
400 // passes). If there are no more active streams and the session
401 // isn't closed yet, close it.
402 void MaybeFinishGoingAway();
404 // Retrieves information on the current state of the SPDY session as a
405 // Value. Caller takes possession of the returned value.
406 base::Value
* GetInfoAsValue() const;
408 // Indicates whether the session is being reused after having successfully
409 // used to send/receive data in the past or if the underlying socket was idle
410 // before being used for a SPDY session.
411 bool IsReused() const;
413 // Returns true if the underlying transport socket ever had any reads or
415 bool WasEverUsed() const {
416 return connection_
->socket()->WasEverUsed();
419 // Returns the load timing information from the perspective of the given
420 // stream. If it's not the first stream, the connection is considered reused
423 // This uses a different notion of reuse than IsReused(). This function
424 // sets |socket_reused| to false only if |stream_id| is the ID of the first
425 // stream using the session. IsReused(), on the other hand, indicates if the
426 // session has been used to send/receive data at all.
427 bool GetLoadTimingInfo(SpdyStreamId stream_id
,
428 LoadTimingInfo
* load_timing_info
) const;
430 // Returns true if session is not currently active
431 bool is_active() const {
432 return !active_streams_
.empty() || !created_streams_
.empty();
435 // Access to the number of active and pending streams. These are primarily
436 // available for testing and diagnostics.
437 size_t num_active_streams() const { return active_streams_
.size(); }
438 size_t num_unclaimed_pushed_streams() const {
439 return unclaimed_pushed_streams_
.size();
441 size_t num_created_streams() const { return created_streams_
.size(); }
443 size_t num_pushed_streams() const { return num_pushed_streams_
; }
444 size_t num_active_pushed_streams() const {
445 return num_active_pushed_streams_
;
448 size_t pending_create_stream_queue_size(RequestPriority priority
) const {
449 DCHECK_GE(priority
, MINIMUM_PRIORITY
);
450 DCHECK_LE(priority
, MAXIMUM_PRIORITY
);
451 return pending_create_stream_queues_
[priority
].size();
454 // Returns the (version-dependent) flow control state.
455 FlowControlState
flow_control_state() const {
456 return flow_control_state_
;
459 // Returns the current |stream_initial_send_window_size_|.
460 int32
stream_initial_send_window_size() const {
461 return stream_initial_send_window_size_
;
464 // Returns the current |stream_max_recv_window_size_|.
465 int32
stream_max_recv_window_size() const {
466 return stream_max_recv_window_size_
;
469 // Returns true if no stream in the session can send data due to
470 // session flow control.
471 bool IsSendStalled() const {
473 flow_control_state_
== FLOW_CONTROL_STREAM_AND_SESSION
&&
474 session_send_window_size_
== 0;
477 const BoundNetLog
& net_log() const { return net_log_
; }
479 int GetPeerAddress(IPEndPoint
* address
) const;
480 int GetLocalAddress(IPEndPoint
* address
) const;
482 // Adds |alias| to set of aliases associated with this session.
483 void AddPooledAlias(const SpdySessionKey
& alias_key
);
485 // Returns the set of aliases associated with this session.
486 const std::set
<SpdySessionKey
>& pooled_aliases() const {
487 return pooled_aliases_
;
490 SpdyMajorVersion
GetProtocolVersion() const;
492 size_t GetDataFrameMinimumSize() const {
493 return buffered_spdy_framer_
->GetDataFrameMinimumSize();
496 size_t GetControlFrameHeaderSize() const {
497 return buffered_spdy_framer_
->GetControlFrameHeaderSize();
500 size_t GetFrameMinimumSize() const {
501 return buffered_spdy_framer_
->GetFrameMinimumSize();
504 size_t GetFrameMaximumSize() const {
505 return buffered_spdy_framer_
->GetFrameMaximumSize();
508 size_t GetDataFrameMaximumPayload() const {
509 return buffered_spdy_framer_
->GetDataFrameMaximumPayload();
512 static int32
GetInitialWindowSize(NextProto protocol
) {
513 return protocol
< kProtoSPDY4MinimumVersion
? 65536 : 65535;
516 // https://http2.github.io/http2-spec/#TLSUsage mandates minimum security
517 // standards for TLS.
518 bool HasAcceptableTransportSecurity() const;
520 // Must be used only by |pool_|.
521 base::WeakPtr
<SpdySession
> GetWeakPtr();
523 // HigherLayeredPool implementation:
524 bool CloseOneIdleConnection() override
;
527 friend class base::RefCounted
<SpdySession
>;
528 friend class SpdyStreamRequest
;
529 friend class SpdySessionTest
;
531 // Allow tests to access our innards for testing purposes.
532 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
, ClientPing
);
533 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
, FailedPing
);
534 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
, GetActivePushStream
);
535 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
, DeleteExpiredPushStreams
);
536 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
, ProtocolNegotiation
);
537 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
, ClearSettings
);
538 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
, AdjustRecvWindowSize
);
539 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
, AdjustSendWindowSize
);
540 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
, SessionFlowControlInactiveStream
);
541 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
, SessionFlowControlPadding
);
542 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
, SessionFlowControlNoReceiveLeaks
);
543 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
, SessionFlowControlNoSendLeaks
);
544 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
, SessionFlowControlEndToEnd
);
545 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
, StreamIdSpaceExhausted
);
546 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
, UnstallRacesWithStreamCreation
);
547 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
, GoAwayOnSessionFlowControlError
);
548 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
,
549 RejectPushedStreamExceedingConcurrencyLimit
);
550 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
, IgnoreReservedRemoteStreamsCount
);
551 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
,
552 CancelReservedStreamOnHeadersReceived
);
553 FRIEND_TEST_ALL_PREFIXES(SpdySessionTest
, RejectInvalidUnknownFrames
);
555 typedef std::deque
<base::WeakPtr
<SpdyStreamRequest
> >
556 PendingStreamRequestQueue
;
558 struct ActiveStreamInfo
{
560 explicit ActiveStreamInfo(SpdyStream
* stream
);
564 bool waiting_for_syn_reply
;
566 typedef std::map
<SpdyStreamId
, ActiveStreamInfo
> ActiveStreamMap
;
568 struct PushedStreamInfo
{
570 PushedStreamInfo(SpdyStreamId stream_id
, base::TimeTicks creation_time
);
573 SpdyStreamId stream_id
;
574 base::TimeTicks creation_time
;
576 typedef std::map
<GURL
, PushedStreamInfo
> PushedStreamMap
;
578 typedef std::set
<SpdyStream
*> CreatedStreamSet
;
580 enum AvailabilityState
{
581 // The session is available in its socket pool and can be used
584 // The session can process data on existing streams but will
585 // refuse to create new ones.
587 // The session is draining its write queue in preparation of closing.
588 // Further writes will not be queued, and further reads will not be issued
589 // (though the remainder of a current read may be processed). The session
590 // will be destroyed by its write loop once the write queue is drained.
596 READ_STATE_DO_READ_COMPLETE
,
600 // There is no in-flight write and the write queue is empty.
602 WRITE_STATE_DO_WRITE
,
603 WRITE_STATE_DO_WRITE_COMPLETE
,
606 // Checks whether a stream for the given |url| can be created or
607 // retrieved from the set of unclaimed push streams. Returns OK if
608 // so. Otherwise, the session is closed and an error <
609 // ERR_IO_PENDING is returned.
610 Error
TryAccessStream(const GURL
& url
);
612 // Called by SpdyStreamRequest to start a request to create a
613 // stream. If OK is returned, then |stream| will be filled in with a
614 // valid stream. If ERR_IO_PENDING is returned, then
615 // |request->OnRequestComplete{Success,Failure}()| will be called
616 // when the stream is created (unless it is cancelled). Otherwise,
617 // no stream is created and the error is returned.
618 int TryCreateStream(const base::WeakPtr
<SpdyStreamRequest
>& request
,
619 base::WeakPtr
<SpdyStream
>* stream
);
621 // Actually create a stream into |stream|. Returns OK if successful;
622 // otherwise, returns an error and |stream| is not filled.
623 int CreateStream(const SpdyStreamRequest
& request
,
624 base::WeakPtr
<SpdyStream
>* stream
);
626 // Called by SpdyStreamRequest to remove |request| from the stream
628 void CancelStreamRequest(const base::WeakPtr
<SpdyStreamRequest
>& request
);
630 // Returns the next pending stream request to process, or NULL if
632 base::WeakPtr
<SpdyStreamRequest
> GetNextPendingStreamRequest();
634 // Called when there is room to create more streams (e.g., a stream
635 // was closed). Processes as many pending stream requests as
637 void ProcessPendingStreamRequests();
639 bool TryCreatePushStream(SpdyStreamId stream_id
,
640 SpdyStreamId associated_stream_id
,
641 SpdyPriority priority
,
642 const SpdyHeaderBlock
& headers
);
644 // Close the stream pointed to by the given iterator. Note that that
645 // stream may hold the last reference to the session.
646 void CloseActiveStreamIterator(ActiveStreamMap::iterator it
, int status
);
648 // Close the stream pointed to by the given iterator. Note that that
649 // stream may hold the last reference to the session.
650 void CloseCreatedStreamIterator(CreatedStreamSet::iterator it
, int status
);
652 // Calls EnqueueResetStreamFrame() and then
653 // CloseActiveStreamIterator().
654 void ResetStreamIterator(ActiveStreamMap::iterator it
,
655 SpdyRstStreamStatus status
,
656 const std::string
& description
);
658 // Send a RST_STREAM frame with the given parameters. There should
659 // either be no active stream with the given ID, or that active
660 // stream should be closed shortly after this function is called.
662 // TODO(akalin): Rename this to EnqueueResetStreamFrame().
663 void EnqueueResetStreamFrame(SpdyStreamId stream_id
,
664 RequestPriority priority
,
665 SpdyRstStreamStatus status
,
666 const std::string
& description
);
668 // Calls DoReadLoop. Use this function instead of DoReadLoop when
669 // posting a task to pump the read loop.
670 void PumpReadLoop(ReadState expected_read_state
, int result
);
672 // Advance the ReadState state machine. |expected_read_state| is the
673 // expected starting read state.
675 // This function must always be called via PumpReadLoop().
676 int DoReadLoop(ReadState expected_read_state
, int result
);
677 // The implementations of the states of the ReadState state machine.
679 int DoReadComplete(int result
);
681 // Calls DoWriteLoop. If |availability_state_| is STATE_DRAINING and no
682 // writes remain, the session is removed from the session pool and
685 // Use this function instead of DoWriteLoop when posting a task to
686 // pump the write loop.
687 void PumpWriteLoop(WriteState expected_write_state
, int result
);
689 // Iff the write loop is not currently active, posts a callback into
691 void MaybePostWriteLoop();
693 // Advance the WriteState state machine. |expected_write_state| is
694 // the expected starting write state.
696 // This function must always be called via PumpWriteLoop().
697 int DoWriteLoop(WriteState expected_write_state
, int result
);
698 // The implementations of the states of the WriteState state machine.
700 int DoWriteComplete(int result
);
702 // TODO(akalin): Rename the Send* and Write* functions below to
705 // Send initial data. Called when a connection is successfully
706 // established in InitializeWithSocket() and
707 // |enable_sending_initial_data_| is true.
708 void SendInitialData();
710 // Helper method to send a SETTINGS frame.
711 void SendSettings(const SettingsMap
& settings
);
713 // Handle SETTING. Either when we send settings, or when we receive a
714 // SETTINGS control frame, update our SpdySession accordingly.
715 void HandleSetting(uint32 id
, uint32 value
);
717 // Adjust the send window size of all ActiveStreams and PendingStreamRequests.
718 void UpdateStreamsSendWindowSize(int32 delta_window_size
);
720 // Send the PING (preface-PING) frame.
721 void SendPrefacePingIfNoneInFlight();
723 // Send PING if there are no PINGs in flight and we haven't heard from server.
724 void SendPrefacePing();
726 // Send a single WINDOW_UPDATE frame.
727 void SendWindowUpdateFrame(SpdyStreamId stream_id
, uint32 delta_window_size
,
728 RequestPriority priority
);
730 // Send the PING frame.
731 void WritePingFrame(SpdyPingId unique_id
, bool is_ack
);
733 // Post a CheckPingStatus call after delay. Don't post if there is already
734 // CheckPingStatus running.
735 void PlanToCheckPingStatus();
737 // Check the status of the connection. It calls |CloseSessionOnError| if we
738 // haven't received any data in |kHungInterval| time period.
739 void CheckPingStatus(base::TimeTicks last_check_time
);
741 // Get a new stream id.
742 SpdyStreamId
GetNewStreamId();
744 // Pushes the given frame with the given priority into the write
745 // queue for the session.
746 void EnqueueSessionWrite(RequestPriority priority
,
747 SpdyFrameType frame_type
,
748 scoped_ptr
<SpdyFrame
> frame
);
750 // Puts |producer| associated with |stream| onto the write queue
751 // with the given priority.
752 void EnqueueWrite(RequestPriority priority
,
753 SpdyFrameType frame_type
,
754 scoped_ptr
<SpdyBufferProducer
> producer
,
755 const base::WeakPtr
<SpdyStream
>& stream
);
757 // Inserts a newly-created stream into |created_streams_|.
758 void InsertCreatedStream(scoped_ptr
<SpdyStream
> stream
);
760 // Activates |stream| (which must be in |created_streams_|) by
761 // assigning it an ID and returns it.
762 scoped_ptr
<SpdyStream
> ActivateCreatedStream(SpdyStream
* stream
);
764 // Inserts a newly-activated stream into |active_streams_|.
765 void InsertActivatedStream(scoped_ptr
<SpdyStream
> stream
);
767 // Remove all internal references to |stream|, call OnClose() on it,
768 // and process any pending stream requests before deleting it. Note
769 // that |stream| may hold the last reference to the session.
770 void DeleteStream(scoped_ptr
<SpdyStream
> stream
, int status
);
772 // Check if we have a pending pushed-stream for this url
773 // Returns the stream if found (and returns it from the pending
774 // list). Returns NULL otherwise.
775 base::WeakPtr
<SpdyStream
> GetActivePushStream(const GURL
& url
);
777 // Delegates to |stream->OnInitialResponseHeadersReceived()|. If an
778 // error is returned, the last reference to |this| may have been
780 int OnInitialResponseHeadersReceived(const SpdyHeaderBlock
& response_headers
,
781 base::Time response_time
,
782 base::TimeTicks recv_first_byte_time
,
785 void RecordPingRTTHistogram(base::TimeDelta duration
);
786 void RecordHistograms();
787 void RecordProtocolErrorHistogram(SpdyProtocolErrorDetails details
);
789 // DCHECKs that |availability_state_| >= STATE_GOING_AWAY, that
790 // there are no pending stream creation requests, and that there are
791 // no created streams.
792 void DcheckGoingAway() const;
794 // Calls DcheckGoingAway(), then DCHECKs that |availability_state_|
795 // == STATE_DRAINING, |error_on_close_| has a valid value, and that there
796 // are no active streams or unclaimed pushed streams.
797 void DcheckDraining() const;
799 // If the session is already draining, does nothing. Otherwise, moves
800 // the session to the draining state.
801 void DoDrainSession(Error err
, const std::string
& description
);
803 // Called right before closing a (possibly-inactive) stream for a
804 // reason other than being requested to by the stream.
805 void LogAbandonedStream(SpdyStream
* stream
, Error status
);
807 // Called right before closing an active stream for a reason other
808 // than being requested to by the stream.
809 void LogAbandonedActiveStream(ActiveStreamMap::const_iterator it
,
812 // Invokes a user callback for stream creation. We provide this method so it
813 // can be deferred to the MessageLoop, so we avoid re-entrancy problems.
814 void CompleteStreamRequest(
815 const base::WeakPtr
<SpdyStreamRequest
>& pending_request
);
817 // Remove old unclaimed pushed streams.
818 void DeleteExpiredPushedStreams();
820 // BufferedSpdyFramerVisitorInterface:
821 void OnError(SpdyFramer::SpdyError error_code
) override
;
822 void OnStreamError(SpdyStreamId stream_id
,
823 const std::string
& description
) override
;
824 void OnPing(SpdyPingId unique_id
, bool is_ack
) override
;
825 void OnRstStream(SpdyStreamId stream_id
, SpdyRstStreamStatus status
) override
;
826 void OnGoAway(SpdyStreamId last_accepted_stream_id
,
827 SpdyGoAwayStatus status
) override
;
828 void OnDataFrameHeader(SpdyStreamId stream_id
,
831 void OnStreamFrameData(SpdyStreamId stream_id
,
835 void OnStreamPadding(SpdyStreamId stream_id
, size_t len
) override
;
836 void OnSettings(bool clear_persisted
) override
;
837 void OnSetting(SpdySettingsIds id
, uint8 flags
, uint32 value
) override
;
838 void OnWindowUpdate(SpdyStreamId stream_id
,
839 uint32 delta_window_size
) override
;
840 void OnPushPromise(SpdyStreamId stream_id
,
841 SpdyStreamId promised_stream_id
,
842 const SpdyHeaderBlock
& headers
) override
;
843 void OnSynStream(SpdyStreamId stream_id
,
844 SpdyStreamId associated_stream_id
,
845 SpdyPriority priority
,
848 const SpdyHeaderBlock
& headers
) override
;
849 void OnSynReply(SpdyStreamId stream_id
,
851 const SpdyHeaderBlock
& headers
) override
;
852 void OnHeaders(SpdyStreamId stream_id
,
854 SpdyPriority priority
,
856 const SpdyHeaderBlock
& headers
) override
;
857 bool OnUnknownFrame(SpdyStreamId stream_id
, int frame_type
) override
;
859 // SpdyFramerDebugVisitorInterface
860 void OnSendCompressedFrame(SpdyStreamId stream_id
,
863 size_t frame_len
) override
;
864 void OnReceiveCompressedFrame(SpdyStreamId stream_id
,
866 size_t frame_len
) override
;
868 // Called when bytes are consumed from a SpdyBuffer for a DATA frame
869 // that is to be written or is being written. Increases the send
870 // window size accordingly if some or all of the SpdyBuffer is being
873 // If session flow control is turned off, this must not be called.
874 void OnWriteBufferConsumed(size_t frame_payload_size
,
876 SpdyBuffer::ConsumeSource consume_source
);
878 // Called by OnWindowUpdate() (which is in turn called by the
879 // framer) to increase this session's send window size by
880 // |delta_window_size| from a WINDOW_UPDATE frome, which must be at
881 // least 1. If |delta_window_size| would cause this session's send
882 // window size to overflow, does nothing.
884 // If session flow control is turned off, this must not be called.
885 void IncreaseSendWindowSize(int32 delta_window_size
);
887 // If session flow control is turned on, called by CreateDataFrame()
888 // (which is in turn called by a stream) to decrease this session's
889 // send window size by |delta_window_size|, which must be at least 1
890 // and at most kMaxSpdyFrameChunkSize. |delta_window_size| must not
891 // cause this session's send window size to go negative.
893 // If session flow control is turned off, this must not be called.
894 void DecreaseSendWindowSize(int32 delta_window_size
);
896 // Called when bytes are consumed by the delegate from a SpdyBuffer
897 // containing received data. Increases the receive window size
900 // If session flow control is turned off, this must not be called.
901 void OnReadBufferConsumed(size_t consume_size
,
902 SpdyBuffer::ConsumeSource consume_source
);
904 // Called by OnReadBufferConsume to increase this session's receive
905 // window size by |delta_window_size|, which must be at least 1 and
906 // must not cause this session's receive window size to overflow,
907 // possibly also sending a WINDOW_UPDATE frame. Also called during
908 // initialization to set the initial receive window size.
910 // If session flow control is turned off, this must not be called.
911 void IncreaseRecvWindowSize(int32 delta_window_size
);
913 // Called by OnStreamFrameData (which is in turn called by the
914 // framer) to decrease this session's receive window size by
915 // |delta_window_size|, which must be at least 1 and must not cause
916 // this session's receive window size to go negative.
918 // If session flow control is turned off, this must not be called.
919 void DecreaseRecvWindowSize(int32 delta_window_size
);
921 // Queue a send-stalled stream for possibly resuming once we're not
922 // send-stalled anymore.
923 void QueueSendStalledStream(const SpdyStream
& stream
);
925 // Go through the queue of send-stalled streams and try to resume as
927 void ResumeSendStalledStreams();
929 // Returns the next stream to possibly resume, or 0 if the queue is
931 SpdyStreamId
PopStreamToPossiblyResume();
933 // --------------------------
934 // Helper methods for testing
935 // --------------------------
937 void set_connection_at_risk_of_loss_time(base::TimeDelta duration
) {
938 connection_at_risk_of_loss_time_
= duration
;
941 void set_hung_interval(base::TimeDelta duration
) {
942 hung_interval_
= duration
;
945 void set_max_concurrent_pushed_streams(size_t value
) {
946 max_concurrent_pushed_streams_
= value
;
949 int64
pings_in_flight() const { return pings_in_flight_
; }
951 SpdyPingId
next_ping_id() const { return next_ping_id_
; }
953 base::TimeTicks
last_activity_time() const { return last_activity_time_
; }
955 bool check_ping_status_pending() const { return check_ping_status_pending_
; }
957 size_t max_concurrent_streams() const { return max_concurrent_streams_
; }
959 // Returns the SSLClientSocket that this SPDY session sits on top of,
960 // or NULL, if the transport is not SSL.
961 SSLClientSocket
* GetSSLClientSocket() const;
963 // Whether Do{Read,Write}Loop() is in the call stack. Useful for
964 // making sure we don't destroy ourselves prematurely in that case.
967 // The key used to identify this session.
968 const SpdySessionKey spdy_session_key_
;
970 // Set set of SpdySessionKeys for which this session has serviced
972 std::set
<SpdySessionKey
> pooled_aliases_
;
974 // |pool_| owns us, therefore its lifetime must exceed ours. We set
975 // this to NULL after we are removed from the pool.
976 SpdySessionPool
* pool_
;
977 const base::WeakPtr
<HttpServerProperties
> http_server_properties_
;
979 TransportSecurityState
* transport_security_state_
;
981 // The socket handle for this session.
982 scoped_ptr
<ClientSocketHandle
> connection_
;
984 // The read buffer used to read data from the socket.
985 scoped_refptr
<IOBuffer
> read_buffer_
;
987 SpdyStreamId stream_hi_water_mark_
; // The next stream id to use.
989 // Used to ensure the server increments push stream ids correctly.
990 SpdyStreamId last_accepted_push_stream_id_
;
992 // Queue, for each priority, of pending stream requests that have
993 // not yet been satisfied.
994 PendingStreamRequestQueue pending_create_stream_queues_
[NUM_PRIORITIES
];
996 // Map from stream id to all active streams. Streams are active in the sense
997 // that they have a consumer (typically SpdyNetworkTransaction and regardless
998 // of whether or not there is currently any ongoing IO [might be waiting for
999 // the server to start pushing the stream]) or there are still network events
1000 // incoming even though the consumer has already gone away (cancellation).
1002 // |active_streams_| owns all its SpdyStream objects.
1004 // TODO(willchan): Perhaps we should separate out cancelled streams and move
1005 // them into a separate ActiveStreamMap, and not deliver network events to
1007 ActiveStreamMap active_streams_
;
1009 // (Bijective) map from the URL to the ID of the streams that have
1010 // already started to be pushed by the server, but do not have
1011 // consumers yet. Contains a subset of |active_streams_|.
1012 PushedStreamMap unclaimed_pushed_streams_
;
1014 // Set of all created streams but that have not yet sent any frames.
1016 // |created_streams_| owns all its SpdyStream objects.
1017 CreatedStreamSet created_streams_
;
1019 // Number of pushed streams. All active streams are stored in
1020 // |active_streams_|, but it's better to know the number of push streams
1021 // without traversing the whole collection.
1022 size_t num_pushed_streams_
;
1024 // Number of active pushed streams in |active_streams_|, i.e. not in reserved
1025 // remote state. Streams in reserved state are not counted towards any
1026 // concurrency limits.
1027 size_t num_active_pushed_streams_
;
1030 SpdyWriteQueue write_queue_
;
1032 // Data for the frame we are currently sending.
1034 // The buffer we're currently writing.
1035 scoped_ptr
<SpdyBuffer
> in_flight_write_
;
1036 // The type of the frame in |in_flight_write_|.
1037 SpdyFrameType in_flight_write_frame_type_
;
1038 // The size of the frame in |in_flight_write_|.
1039 size_t in_flight_write_frame_size_
;
1040 // The stream to notify when |in_flight_write_| has been written to
1041 // the socket completely.
1042 base::WeakPtr
<SpdyStream
> in_flight_write_stream_
;
1044 // Flag if we're using an SSL connection for this SpdySession.
1047 // Certificate error code when using a secure connection.
1048 int certificate_error_code_
;
1050 // Spdy Frame state.
1051 scoped_ptr
<BufferedSpdyFramer
> buffered_spdy_framer_
;
1053 // The state variables.
1054 AvailabilityState availability_state_
;
1055 ReadState read_state_
;
1056 WriteState write_state_
;
1058 // If the session is closing (i.e., |availability_state_| is STATE_DRAINING),
1059 // then |error_on_close_| holds the error with which it was closed, which
1060 // may be OK (upon a polite GOAWAY) or an error < ERR_IO_PENDING otherwise.
1061 // Initialized to OK.
1062 Error error_on_close_
;
1065 size_t max_concurrent_streams_
; // 0 if no limit
1066 size_t max_concurrent_streams_limit_
;
1067 size_t max_concurrent_pushed_streams_
;
1069 // Some statistics counters for the session.
1070 int streams_initiated_count_
;
1071 int streams_pushed_count_
;
1072 int streams_pushed_and_claimed_count_
;
1073 int streams_abandoned_count_
;
1075 // |total_bytes_received_| keeps track of all the bytes read by the
1076 // SpdySession. It is used by the |Net.SpdySettingsCwnd...| histograms.
1077 int total_bytes_received_
;
1079 bool sent_settings_
; // Did this session send settings when it started.
1080 bool received_settings_
; // Did this session receive at least one settings
1082 int stalled_streams_
; // Count of streams that were ever stalled.
1084 // Count of all pings on the wire, for which we have not gotten a response.
1085 int64 pings_in_flight_
;
1087 // This is the next ping_id (unique_id) to be sent in PING frame.
1088 SpdyPingId next_ping_id_
;
1090 // This is the last time we have sent a PING.
1091 base::TimeTicks last_ping_sent_time_
;
1093 // This is the last time we had activity in the session.
1094 base::TimeTicks last_activity_time_
;
1096 // This is the length of the last compressed frame.
1097 size_t last_compressed_frame_len_
;
1099 // This is the next time that unclaimed push streams should be checked for
1101 base::TimeTicks next_unclaimed_push_stream_sweep_time_
;
1103 // Indicate if we have already scheduled a delayed task to check the ping
1105 bool check_ping_status_pending_
;
1107 // Whether to send the (HTTP/2) connection header prefix.
1108 bool send_connection_header_prefix_
;
1110 // The (version-dependent) flow control state.
1111 FlowControlState flow_control_state_
;
1113 // Current send window size. Zero unless session flow control is turned on.
1114 int32 session_send_window_size_
;
1116 // Maximum receive window size. Each time a WINDOW_UPDATE is sent, it
1117 // restores the receive window size to this value. Zero unless session flow
1118 // control is turned on.
1119 int32 session_max_recv_window_size_
;
1121 // Sum of |session_unacked_recv_window_bytes_| and current receive window
1122 // size. Zero unless session flow control is turned on.
1123 // TODO(bnc): Rename or change semantics so that |window_size_| is actual
1125 int32 session_recv_window_size_
;
1127 // When bytes are consumed, SpdyIOBuffer destructor calls back to SpdySession,
1128 // and this member keeps count of them until the corresponding WINDOW_UPDATEs
1129 // are sent. Zero unless session flow control is turned on.
1130 int32 session_unacked_recv_window_bytes_
;
1132 // Initial send window size for this session's streams. Can be
1133 // changed by an arriving SETTINGS frame. Newly created streams use
1134 // this value for the initial send window size.
1135 int32 stream_initial_send_window_size_
;
1137 // Initial receive window size for this session's streams. There are
1138 // plans to add a command line switch that would cause a SETTINGS
1139 // frame with window size announcement to be sent on startup. Newly
1140 // created streams will use this value for the initial receive
1142 int32 stream_max_recv_window_size_
;
1144 // A queue of stream IDs that have been send-stalled at some point
1146 std::deque
<SpdyStreamId
> stream_send_unstall_queue_
[NUM_PRIORITIES
];
1148 BoundNetLog net_log_
;
1150 // Outside of tests, these should always be true.
1151 bool verify_domain_authentication_
;
1152 bool enable_sending_initial_data_
;
1153 bool enable_compression_
;
1154 bool enable_ping_based_connection_checking_
;
1156 // The SPDY protocol used. Always between kProtoSPDYMinimumVersion and
1157 // kProtoSPDYMaximumVersion.
1158 NextProto protocol_
;
1160 // |connection_at_risk_of_loss_time_| is an optimization to avoid sending
1161 // wasteful preface pings (when we just got some data).
1163 // If it is zero (the most conservative figure), then we always send the
1164 // preface ping (when none are in flight).
1166 // It is common for TCP/IP sessions to time out in about 3-5 minutes.
1167 // Certainly if it has been more than 3 minutes, we do want to send a preface
1170 // We don't think any connection will time out in under about 10 seconds. So
1171 // this might as well be set to something conservative like 10 seconds. Later,
1172 // we could adjust it to send fewer pings perhaps.
1173 base::TimeDelta connection_at_risk_of_loss_time_
;
1175 // The amount of time that we are willing to tolerate with no activity (of any
1176 // form), while there is a ping in flight, before we declare the connection to
1177 // be hung. TODO(rtenneti): When hung, instead of resetting connection, race
1178 // to build a new connection, and see if that completes before we (finally)
1179 // get a PING response (http://crbug.com/127812).
1180 base::TimeDelta hung_interval_
;
1182 // This SPDY proxy is allowed to push resources from origins that are
1183 // different from those of their associated streams.
1184 HostPortPair trusted_spdy_proxy_
;
1186 TimeFunc time_func_
;
1188 // Used for posting asynchronous IO tasks. We use this even though
1189 // SpdySession is refcounted because we don't need to keep the SpdySession
1190 // alive if the last reference is within a RunnableMethod. Just revoke the
1192 base::WeakPtrFactory
<SpdySession
> weak_factory_
;
1197 #endif // NET_SPDY_SPDY_SESSION_H_