Index: net/websockets/websocket_basic_stream.cc |
diff --git a/net/websockets/websocket_basic_stream.cc b/net/websockets/websocket_basic_stream.cc |
deleted file mode 100644 |
index 2890a9e493f8a4b5a0eb7bcc798cd4d912c0cd7f..0000000000000000000000000000000000000000 |
--- a/net/websockets/websocket_basic_stream.cc |
+++ /dev/null |
@@ -1,424 +0,0 @@ |
-// Copyright 2013 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/websockets/websocket_basic_stream.h" |
- |
-#include <algorithm> |
-#include <limits> |
-#include <string> |
-#include <vector> |
- |
-#include "base/basictypes.h" |
-#include "base/bind.h" |
-#include "base/logging.h" |
-#include "base/numerics/safe_conversions.h" |
-#include "net/base/io_buffer.h" |
-#include "net/base/net_errors.h" |
-#include "net/socket/client_socket_handle.h" |
-#include "net/websockets/websocket_errors.h" |
-#include "net/websockets/websocket_frame.h" |
-#include "net/websockets/websocket_frame_parser.h" |
- |
-namespace net { |
- |
-namespace { |
- |
-// This uses type uint64 to match the definition of |
-// WebSocketFrameHeader::payload_length in websocket_frame.h. |
-const uint64 kMaxControlFramePayload = 125; |
- |
-// The number of bytes to attempt to read at a time. |
-// TODO(ricea): See if there is a better number or algorithm to fulfill our |
-// requirements: |
-// 1. We would like to use minimal memory on low-bandwidth or idle connections |
-// 2. We would like to read as close to line speed as possible on |
-// high-bandwidth connections |
-// 3. We can't afford to cause jank on the IO thread by copying large buffers |
-// around |
-// 4. We would like to hit any sweet-spots that might exist in terms of network |
-// packet sizes / encryption block sizes / IPC alignment issues, etc. |
-const int kReadBufferSize = 32 * 1024; |
- |
-typedef ScopedVector<WebSocketFrame>::const_iterator WebSocketFrameIterator; |
- |
-// Returns the total serialized size of |frames|. This function assumes that |
-// |frames| will be serialized with mask field. This function forces the |
-// masked bit of the frames on. |
-int CalculateSerializedSizeAndTurnOnMaskBit( |
- ScopedVector<WebSocketFrame>* frames) { |
- const uint64 kMaximumTotalSize = std::numeric_limits<int>::max(); |
- |
- uint64 total_size = 0; |
- for (WebSocketFrameIterator it = frames->begin(); it != frames->end(); ++it) { |
- WebSocketFrame* frame = *it; |
- // Force the masked bit on. |
- frame->header.masked = true; |
- // We enforce flow control so the renderer should never be able to force us |
- // to cache anywhere near 2GB of frames. |
- uint64 frame_size = frame->header.payload_length + |
- GetWebSocketFrameHeaderSize(frame->header); |
- CHECK_LE(frame_size, kMaximumTotalSize - total_size) |
- << "Aborting to prevent overflow"; |
- total_size += frame_size; |
- } |
- return static_cast<int>(total_size); |
-} |
- |
-} // namespace |
- |
-WebSocketBasicStream::WebSocketBasicStream( |
- scoped_ptr<ClientSocketHandle> connection, |
- const scoped_refptr<GrowableIOBuffer>& http_read_buffer, |
- const std::string& sub_protocol, |
- const std::string& extensions) |
- : read_buffer_(new IOBufferWithSize(kReadBufferSize)), |
- connection_(connection.Pass()), |
- http_read_buffer_(http_read_buffer), |
- sub_protocol_(sub_protocol), |
- extensions_(extensions), |
- generate_websocket_masking_key_(&GenerateWebSocketMaskingKey) { |
- // http_read_buffer_ should not be set if it contains no data. |
- if (http_read_buffer_.get() && http_read_buffer_->offset() == 0) |
- http_read_buffer_ = NULL; |
- DCHECK(connection_->is_initialized()); |
-} |
- |
-WebSocketBasicStream::~WebSocketBasicStream() { Close(); } |
- |
-int WebSocketBasicStream::ReadFrames(ScopedVector<WebSocketFrame>* frames, |
- const CompletionCallback& callback) { |
- DCHECK(frames->empty()); |
- // If there is data left over after parsing the HTTP headers, attempt to parse |
- // it as WebSocket frames. |
- if (http_read_buffer_.get()) { |
- DCHECK_GE(http_read_buffer_->offset(), 0); |
- // We cannot simply copy the data into read_buffer_, as it might be too |
- // large. |
- scoped_refptr<GrowableIOBuffer> buffered_data; |
- buffered_data.swap(http_read_buffer_); |
- DCHECK(http_read_buffer_.get() == NULL); |
- ScopedVector<WebSocketFrameChunk> frame_chunks; |
- if (!parser_.Decode(buffered_data->StartOfBuffer(), |
- buffered_data->offset(), |
- &frame_chunks)) |
- return WebSocketErrorToNetError(parser_.websocket_error()); |
- if (!frame_chunks.empty()) { |
- int result = ConvertChunksToFrames(&frame_chunks, frames); |
- if (result != ERR_IO_PENDING) |
- return result; |
- } |
- } |
- |
- // Run until socket stops giving us data or we get some frames. |
- while (true) { |
- // base::Unretained(this) here is safe because net::Socket guarantees not to |
- // call any callbacks after Disconnect(), which we call from the |
- // destructor. The caller of ReadFrames() is required to keep |frames| |
- // valid. |
- int result = connection_->socket()->Read( |
- read_buffer_.get(), |
- read_buffer_->size(), |
- base::Bind(&WebSocketBasicStream::OnReadComplete, |
- base::Unretained(this), |
- base::Unretained(frames), |
- callback)); |
- if (result == ERR_IO_PENDING) |
- return result; |
- result = HandleReadResult(result, frames); |
- if (result != ERR_IO_PENDING) |
- return result; |
- DCHECK(frames->empty()); |
- } |
-} |
- |
-int WebSocketBasicStream::WriteFrames(ScopedVector<WebSocketFrame>* frames, |
- const CompletionCallback& callback) { |
- // This function always concatenates all frames into a single buffer. |
- // TODO(ricea): Investigate whether it would be better in some cases to |
- // perform multiple writes with smaller buffers. |
- // |
- // First calculate the size of the buffer we need to allocate. |
- int total_size = CalculateSerializedSizeAndTurnOnMaskBit(frames); |
- scoped_refptr<IOBufferWithSize> combined_buffer( |
- new IOBufferWithSize(total_size)); |
- |
- char* dest = combined_buffer->data(); |
- int remaining_size = total_size; |
- for (WebSocketFrameIterator it = frames->begin(); it != frames->end(); ++it) { |
- WebSocketFrame* frame = *it; |
- WebSocketMaskingKey mask = generate_websocket_masking_key_(); |
- int result = |
- WriteWebSocketFrameHeader(frame->header, &mask, dest, remaining_size); |
- DCHECK_NE(ERR_INVALID_ARGUMENT, result) |
- << "WriteWebSocketFrameHeader() says that " << remaining_size |
- << " is not enough to write the header in. This should not happen."; |
- CHECK_GE(result, 0) << "Potentially security-critical check failed"; |
- dest += result; |
- remaining_size -= result; |
- |
- CHECK_LE(frame->header.payload_length, static_cast<uint64>(remaining_size)); |
- const int frame_size = static_cast<int>(frame->header.payload_length); |
- if (frame_size > 0) { |
- const char* const frame_data = frame->data->data(); |
- std::copy(frame_data, frame_data + frame_size, dest); |
- MaskWebSocketFramePayload(mask, 0, dest, frame_size); |
- dest += frame_size; |
- remaining_size -= frame_size; |
- } |
- } |
- DCHECK_EQ(0, remaining_size) << "Buffer size calculation was wrong; " |
- << remaining_size << " bytes left over."; |
- scoped_refptr<DrainableIOBuffer> drainable_buffer( |
- new DrainableIOBuffer(combined_buffer.get(), total_size)); |
- return WriteEverything(drainable_buffer, callback); |
-} |
- |
-void WebSocketBasicStream::Close() { connection_->socket()->Disconnect(); } |
- |
-std::string WebSocketBasicStream::GetSubProtocol() const { |
- return sub_protocol_; |
-} |
- |
-std::string WebSocketBasicStream::GetExtensions() const { return extensions_; } |
- |
-/*static*/ |
-scoped_ptr<WebSocketBasicStream> |
-WebSocketBasicStream::CreateWebSocketBasicStreamForTesting( |
- scoped_ptr<ClientSocketHandle> connection, |
- const scoped_refptr<GrowableIOBuffer>& http_read_buffer, |
- const std::string& sub_protocol, |
- const std::string& extensions, |
- WebSocketMaskingKeyGeneratorFunction key_generator_function) { |
- scoped_ptr<WebSocketBasicStream> stream(new WebSocketBasicStream( |
- connection.Pass(), http_read_buffer, sub_protocol, extensions)); |
- stream->generate_websocket_masking_key_ = key_generator_function; |
- return stream.Pass(); |
-} |
- |
-int WebSocketBasicStream::WriteEverything( |
- const scoped_refptr<DrainableIOBuffer>& buffer, |
- const CompletionCallback& callback) { |
- while (buffer->BytesRemaining() > 0) { |
- // The use of base::Unretained() here is safe because on destruction we |
- // disconnect the socket, preventing any further callbacks. |
- int result = connection_->socket()->Write( |
- buffer.get(), |
- buffer->BytesRemaining(), |
- base::Bind(&WebSocketBasicStream::OnWriteComplete, |
- base::Unretained(this), |
- buffer, |
- callback)); |
- if (result > 0) { |
- buffer->DidConsume(result); |
- } else { |
- return result; |
- } |
- } |
- return OK; |
-} |
- |
-void WebSocketBasicStream::OnWriteComplete( |
- const scoped_refptr<DrainableIOBuffer>& buffer, |
- const CompletionCallback& callback, |
- int result) { |
- if (result < 0) { |
- DCHECK_NE(ERR_IO_PENDING, result); |
- callback.Run(result); |
- return; |
- } |
- |
- DCHECK_NE(0, result); |
- buffer->DidConsume(result); |
- result = WriteEverything(buffer, callback); |
- if (result != ERR_IO_PENDING) |
- callback.Run(result); |
-} |
- |
-int WebSocketBasicStream::HandleReadResult( |
- int result, |
- ScopedVector<WebSocketFrame>* frames) { |
- DCHECK_NE(ERR_IO_PENDING, result); |
- DCHECK(frames->empty()); |
- if (result < 0) |
- return result; |
- if (result == 0) |
- return ERR_CONNECTION_CLOSED; |
- ScopedVector<WebSocketFrameChunk> frame_chunks; |
- if (!parser_.Decode(read_buffer_->data(), result, &frame_chunks)) |
- return WebSocketErrorToNetError(parser_.websocket_error()); |
- if (frame_chunks.empty()) |
- return ERR_IO_PENDING; |
- return ConvertChunksToFrames(&frame_chunks, frames); |
-} |
- |
-int WebSocketBasicStream::ConvertChunksToFrames( |
- ScopedVector<WebSocketFrameChunk>* frame_chunks, |
- ScopedVector<WebSocketFrame>* frames) { |
- for (size_t i = 0; i < frame_chunks->size(); ++i) { |
- scoped_ptr<WebSocketFrame> frame; |
- int result = ConvertChunkToFrame( |
- scoped_ptr<WebSocketFrameChunk>((*frame_chunks)[i]), &frame); |
- (*frame_chunks)[i] = NULL; |
- if (result != OK) |
- return result; |
- if (frame) |
- frames->push_back(frame.release()); |
- } |
- // All the elements of |frame_chunks| are now NULL, so there is no point in |
- // calling delete on them all. |
- frame_chunks->weak_clear(); |
- if (frames->empty()) |
- return ERR_IO_PENDING; |
- return OK; |
-} |
- |
-int WebSocketBasicStream::ConvertChunkToFrame( |
- scoped_ptr<WebSocketFrameChunk> chunk, |
- scoped_ptr<WebSocketFrame>* frame) { |
- DCHECK(frame->get() == NULL); |
- bool is_first_chunk = false; |
- if (chunk->header) { |
- DCHECK(current_frame_header_ == NULL) |
- << "Received the header for a new frame without notification that " |
- << "the previous frame was complete (bug in WebSocketFrameParser?)"; |
- is_first_chunk = true; |
- current_frame_header_.swap(chunk->header); |
- } |
- const int chunk_size = chunk->data.get() ? chunk->data->size() : 0; |
- DCHECK(current_frame_header_) << "Unexpected header-less chunk received " |
- << "(final_chunk = " << chunk->final_chunk |
- << ", data size = " << chunk_size |
- << ") (bug in WebSocketFrameParser?)"; |
- scoped_refptr<IOBufferWithSize> data_buffer; |
- data_buffer.swap(chunk->data); |
- const bool is_final_chunk = chunk->final_chunk; |
- const WebSocketFrameHeader::OpCode opcode = current_frame_header_->opcode; |
- if (WebSocketFrameHeader::IsKnownControlOpCode(opcode)) { |
- bool protocol_error = false; |
- if (!current_frame_header_->final) { |
- DVLOG(1) << "WebSocket protocol error. Control frame, opcode=" << opcode |
- << " received with FIN bit unset."; |
- protocol_error = true; |
- } |
- if (current_frame_header_->payload_length > kMaxControlFramePayload) { |
- DVLOG(1) << "WebSocket protocol error. Control frame, opcode=" << opcode |
- << ", payload_length=" << current_frame_header_->payload_length |
- << " exceeds maximum payload length for a control message."; |
- protocol_error = true; |
- } |
- if (protocol_error) { |
- current_frame_header_.reset(); |
- return ERR_WS_PROTOCOL_ERROR; |
- } |
- if (!is_final_chunk) { |
- DVLOG(2) << "Encountered a split control frame, opcode " << opcode; |
- if (incomplete_control_frame_body_.get()) { |
- DVLOG(3) << "Appending to an existing split control frame."; |
- AddToIncompleteControlFrameBody(data_buffer); |
- } else { |
- DVLOG(3) << "Creating new storage for an incomplete control frame."; |
- incomplete_control_frame_body_ = new GrowableIOBuffer(); |
- // This method checks for oversize control frames above, so as long as |
- // the frame parser is working correctly, this won't overflow. If a bug |
- // does cause it to overflow, it will CHECK() in |
- // AddToIncompleteControlFrameBody() without writing outside the buffer. |
- incomplete_control_frame_body_->SetCapacity(kMaxControlFramePayload); |
- AddToIncompleteControlFrameBody(data_buffer); |
- } |
- return OK; |
- } |
- if (incomplete_control_frame_body_.get()) { |
- DVLOG(2) << "Rejoining a split control frame, opcode " << opcode; |
- AddToIncompleteControlFrameBody(data_buffer); |
- const int body_size = incomplete_control_frame_body_->offset(); |
- DCHECK_EQ(body_size, |
- static_cast<int>(current_frame_header_->payload_length)); |
- scoped_refptr<IOBufferWithSize> body = new IOBufferWithSize(body_size); |
- memcpy(body->data(), |
- incomplete_control_frame_body_->StartOfBuffer(), |
- body_size); |
- incomplete_control_frame_body_ = NULL; // Frame now complete. |
- DCHECK(is_final_chunk); |
- *frame = CreateFrame(is_final_chunk, body); |
- return OK; |
- } |
- } |
- |
- // Apply basic sanity checks to the |payload_length| field from the frame |
- // header. A check for exact equality can only be used when the whole frame |
- // arrives in one chunk. |
- DCHECK_GE(current_frame_header_->payload_length, |
- base::checked_cast<uint64>(chunk_size)); |
- DCHECK(!is_first_chunk || !is_final_chunk || |
- current_frame_header_->payload_length == |
- base::checked_cast<uint64>(chunk_size)); |
- |
- // Convert the chunk to a complete frame. |
- *frame = CreateFrame(is_final_chunk, data_buffer); |
- return OK; |
-} |
- |
-scoped_ptr<WebSocketFrame> WebSocketBasicStream::CreateFrame( |
- bool is_final_chunk, |
- const scoped_refptr<IOBufferWithSize>& data) { |
- scoped_ptr<WebSocketFrame> result_frame; |
- const bool is_final_chunk_in_message = |
- is_final_chunk && current_frame_header_->final; |
- const int data_size = data.get() ? data->size() : 0; |
- const WebSocketFrameHeader::OpCode opcode = current_frame_header_->opcode; |
- // Empty frames convey no useful information unless they are the first frame |
- // (containing the type and flags) or have the "final" bit set. |
- if (is_final_chunk_in_message || data_size > 0 || |
- current_frame_header_->opcode != |
- WebSocketFrameHeader::kOpCodeContinuation) { |
- result_frame.reset(new WebSocketFrame(opcode)); |
- result_frame->header.CopyFrom(*current_frame_header_); |
- result_frame->header.final = is_final_chunk_in_message; |
- result_frame->header.payload_length = data_size; |
- result_frame->data = data; |
- // Ensure that opcodes Text and Binary are only used for the first frame in |
- // the message. Also clear the reserved bits. |
- // TODO(ricea): If a future extension requires the reserved bits to be |
- // retained on continuation frames, make this behaviour conditional on a |
- // flag set at construction time. |
- if (!is_final_chunk && WebSocketFrameHeader::IsKnownDataOpCode(opcode)) { |
- current_frame_header_->opcode = WebSocketFrameHeader::kOpCodeContinuation; |
- current_frame_header_->reserved1 = false; |
- current_frame_header_->reserved2 = false; |
- current_frame_header_->reserved3 = false; |
- } |
- } |
- // Make sure that a frame header is not applied to any chunks that do not |
- // belong to it. |
- if (is_final_chunk) |
- current_frame_header_.reset(); |
- return result_frame.Pass(); |
-} |
- |
-void WebSocketBasicStream::AddToIncompleteControlFrameBody( |
- const scoped_refptr<IOBufferWithSize>& data_buffer) { |
- if (!data_buffer.get()) |
- return; |
- const int new_offset = |
- incomplete_control_frame_body_->offset() + data_buffer->size(); |
- CHECK_GE(incomplete_control_frame_body_->capacity(), new_offset) |
- << "Control frame body larger than frame header indicates; frame parser " |
- "bug?"; |
- memcpy(incomplete_control_frame_body_->data(), |
- data_buffer->data(), |
- data_buffer->size()); |
- incomplete_control_frame_body_->set_offset(new_offset); |
-} |
- |
-void WebSocketBasicStream::OnReadComplete(ScopedVector<WebSocketFrame>* frames, |
- const CompletionCallback& callback, |
- int result) { |
- result = HandleReadResult(result, frames); |
- if (result == ERR_IO_PENDING) |
- result = ReadFrames(frames, callback); |
- if (result != ERR_IO_PENDING) |
- callback.Run(result); |
-} |
- |
-} // namespace net |