1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
|
// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/390223051): Remove C-library calls to fix the errors.
#pragma allow_unsafe_libc_calls
#endif
#include "remoting/protocol/pseudotcp_adapter.h"
#include <stddef.h>
#include <utility>
#include "base/compiler_specific.h"
#include "base/functional/bind.h"
#include "base/logging.h"
#include "base/time/time.h"
#include "base/timer/timer.h"
#include "net/base/address_list.h"
#include "net/base/completion_once_callback.h"
#include "net/base/io_buffer.h"
#include "net/base/net_errors.h"
#include "net/traffic_annotation/network_traffic_annotation.h"
#include "remoting/protocol/p2p_datagram_socket.h"
using webrtc::PseudoTcp;
namespace {
const int kReadBufferSize = 65536; // Maximum size of a packet.
const uint16_t kDefaultMtu = 1280;
} // namespace
namespace remoting::protocol {
class PseudoTcpAdapter::Core : public webrtc::IPseudoTcpNotify,
public base::RefCounted<Core> {
public:
explicit Core(std::unique_ptr<P2PDatagramSocket> socket);
Core(const Core&) = delete;
Core& operator=(const Core&) = delete;
// Functions used to implement net::StreamSocket.
int Read(const scoped_refptr<net::IOBuffer>& buffer,
int buffer_size,
net::CompletionOnceCallback callback);
int Write(const scoped_refptr<net::IOBuffer>& buffer,
int buffer_size,
net::CompletionOnceCallback callback,
const net::NetworkTrafficAnnotationTag& traffic_annotation);
net::CompletionOnceCallback Connect(net::CompletionOnceCallback callback);
// webrtc::IPseudoTcpNotify interface.
// These notifications are triggered from NotifyPacket.
void OnTcpOpen(webrtc::PseudoTcp* tcp) override;
void OnTcpReadable(webrtc::PseudoTcp* tcp) override;
void OnTcpWriteable(webrtc::PseudoTcp* tcp) override;
// This is triggered by NotifyClock or NotifyPacket.
void OnTcpClosed(webrtc::PseudoTcp* tcp, uint32_t error) override;
// This is triggered by NotifyClock, NotifyPacket, Recv and Send.
WriteResult TcpWritePacket(webrtc::PseudoTcp* tcp,
const char* buffer,
size_t len) override;
void SetAckDelay(int delay_ms);
void SetNoDelay(bool no_delay);
void SetReceiveBufferSize(int32_t size);
void SetSendBufferSize(int32_t size);
void SetWriteWaitsForSend(bool write_waits_for_send);
void DeleteSocket();
private:
friend class base::RefCounted<Core>;
~Core() override;
// These are invoked by the underlying Socket, and may trigger callbacks.
// They hold a reference to |this| while running, to protect from deletion.
void OnRead(int result);
void OnWritten(int result);
// These may trigger callbacks, so the holder must hold a reference on
// the stack while calling them.
void DoReadFromSocket();
void HandleReadResults(int result);
void HandleTcpClock();
// Checks if current write has completed in the write-waits-for-send
// mode.
void CheckWriteComplete();
// This re-sets |timer| without triggering callbacks.
void AdjustClock();
net::CompletionOnceCallback connect_callback_;
net::CompletionOnceCallback read_callback_;
net::CompletionOnceCallback write_callback_;
webrtc::PseudoTcp pseudo_tcp_;
std::unique_ptr<P2PDatagramSocket> socket_;
scoped_refptr<net::IOBuffer> read_buffer_;
int read_buffer_size_;
scoped_refptr<net::IOBuffer> write_buffer_;
int write_buffer_size_;
// Whether we need to wait for data to be sent before completing write.
bool write_waits_for_send_;
// Set to true in the write-waits-for-send mode when we've
// successfully writtend data to the send buffer and waiting for the
// data to be sent to the remote end.
bool waiting_write_position_;
// Number of the bytes written by the last write stored while we wait
// for the data to be sent (i.e. when waiting_write_position_ = true).
int last_write_result_;
bool socket_write_pending_;
scoped_refptr<net::IOBuffer> socket_read_buffer_;
base::OneShotTimer timer_;
};
PseudoTcpAdapter::Core::Core(std::unique_ptr<P2PDatagramSocket> socket)
: pseudo_tcp_(this, 0),
socket_(std::move(socket)),
write_waits_for_send_(false),
waiting_write_position_(false),
socket_write_pending_(false) {
// Doesn't trigger callbacks.
pseudo_tcp_.NotifyMTU(kDefaultMtu);
}
PseudoTcpAdapter::Core::~Core() = default;
int PseudoTcpAdapter::Core::Read(const scoped_refptr<net::IOBuffer>& buffer,
int buffer_size,
net::CompletionOnceCallback callback) {
DCHECK(read_callback_.is_null());
// Reference the Core in case a callback deletes the adapter.
scoped_refptr<Core> core(this);
int result = pseudo_tcp_.Recv(buffer->data(), buffer_size);
if (result < 0) {
result = net::MapSystemError(pseudo_tcp_.GetError());
DCHECK(result < 0);
}
if (result == net::ERR_IO_PENDING) {
read_buffer_ = buffer;
read_buffer_size_ = buffer_size;
read_callback_ = std::move(callback);
}
AdjustClock();
return result;
}
int PseudoTcpAdapter::Core::Write(
const scoped_refptr<net::IOBuffer>& buffer,
int buffer_size,
net::CompletionOnceCallback callback,
const net::NetworkTrafficAnnotationTag& /*traffic_annotation*/) {
DCHECK(write_callback_.is_null());
// Reference the Core in case a callback deletes the adapter.
scoped_refptr<Core> core(this);
int result = pseudo_tcp_.Send(buffer->data(), buffer_size);
if (result < 0) {
result = net::MapSystemError(pseudo_tcp_.GetError());
DCHECK(result < 0);
}
AdjustClock();
if (result == net::ERR_IO_PENDING) {
write_buffer_ = buffer;
write_buffer_size_ = buffer_size;
write_callback_ = std::move(callback);
return result;
}
if (result < 0) {
return result;
}
// Need to wait until the data is sent to the peer when
// send-confirmation mode is enabled.
if (write_waits_for_send_ && pseudo_tcp_.GetBytesBufferedNotSent() > 0) {
DCHECK(!waiting_write_position_);
waiting_write_position_ = true;
last_write_result_ = result;
write_buffer_ = buffer;
write_buffer_size_ = buffer_size;
write_callback_ = std::move(callback);
return net::ERR_IO_PENDING;
}
return result;
}
net::CompletionOnceCallback PseudoTcpAdapter::Core::Connect(
net::CompletionOnceCallback callback) {
DCHECK_EQ(pseudo_tcp_.State(), webrtc::PseudoTcp::TCP_LISTEN);
// Reference the Core in case a callback deletes the adapter.
scoped_refptr<Core> core(this);
// Start the connection attempt.
int result = pseudo_tcp_.Connect();
if (result < 0) {
return callback;
}
AdjustClock();
connect_callback_ = std::move(callback);
DoReadFromSocket();
return {};
}
void PseudoTcpAdapter::Core::OnTcpOpen(PseudoTcp* tcp) {
DCHECK(tcp == &pseudo_tcp_);
if (connect_callback_) {
std::move(connect_callback_).Run(net::OK);
}
OnTcpReadable(tcp);
OnTcpWriteable(tcp);
}
void PseudoTcpAdapter::Core::OnTcpReadable(PseudoTcp* tcp) {
DCHECK_EQ(tcp, &pseudo_tcp_);
if (read_callback_.is_null()) {
return;
}
int result = pseudo_tcp_.Recv(read_buffer_->data(), read_buffer_size_);
if (result < 0) {
result = net::MapSystemError(pseudo_tcp_.GetError());
DCHECK(result < 0);
if (result == net::ERR_IO_PENDING) {
return;
}
}
AdjustClock();
read_buffer_.reset();
std::move(read_callback_).Run(result);
}
void PseudoTcpAdapter::Core::OnTcpWriteable(PseudoTcp* tcp) {
DCHECK_EQ(tcp, &pseudo_tcp_);
if (write_callback_.is_null()) {
return;
}
if (waiting_write_position_) {
CheckWriteComplete();
return;
}
int result = pseudo_tcp_.Send(write_buffer_->data(), write_buffer_size_);
if (result < 0) {
result = net::MapSystemError(pseudo_tcp_.GetError());
DCHECK(result < 0);
if (result == net::ERR_IO_PENDING) {
return;
}
}
AdjustClock();
if (write_waits_for_send_ && pseudo_tcp_.GetBytesBufferedNotSent() > 0) {
DCHECK(!waiting_write_position_);
waiting_write_position_ = true;
last_write_result_ = result;
return;
}
write_buffer_.reset();
std::move(write_callback_).Run(result);
}
void PseudoTcpAdapter::Core::OnTcpClosed(PseudoTcp* tcp, uint32_t error) {
DCHECK_EQ(tcp, &pseudo_tcp_);
if (!connect_callback_.is_null()) {
std::move(connect_callback_).Run(net::MapSystemError(error));
}
if (!read_callback_.is_null()) {
std::move(read_callback_).Run(net::MapSystemError(error));
}
if (!write_callback_.is_null()) {
std::move(write_callback_).Run(net::MapSystemError(error));
}
}
void PseudoTcpAdapter::Core::SetAckDelay(int delay_ms) {
pseudo_tcp_.SetOption(webrtc::PseudoTcp::OPT_ACKDELAY, delay_ms);
}
void PseudoTcpAdapter::Core::SetNoDelay(bool no_delay) {
pseudo_tcp_.SetOption(webrtc::PseudoTcp::OPT_NODELAY, no_delay ? 1 : 0);
}
void PseudoTcpAdapter::Core::SetReceiveBufferSize(int32_t size) {
pseudo_tcp_.SetOption(webrtc::PseudoTcp::OPT_RCVBUF, size);
}
void PseudoTcpAdapter::Core::SetSendBufferSize(int32_t size) {
pseudo_tcp_.SetOption(webrtc::PseudoTcp::OPT_SNDBUF, size);
}
void PseudoTcpAdapter::Core::SetWriteWaitsForSend(bool write_waits_for_send) {
write_waits_for_send_ = write_waits_for_send;
}
void PseudoTcpAdapter::Core::DeleteSocket() {
// Don't dispatch outstanding callbacks when the socket is deleted.
read_callback_.Reset();
read_buffer_.reset();
write_callback_.Reset();
write_buffer_.reset();
connect_callback_.Reset();
socket_.reset();
}
webrtc::IPseudoTcpNotify::WriteResult PseudoTcpAdapter::Core::TcpWritePacket(
PseudoTcp* tcp,
const char* buffer,
size_t len) {
DCHECK_EQ(tcp, &pseudo_tcp_);
// If we already have a write pending, we behave like a congested network,
// returning success for the write, but dropping the packet. PseudoTcp will
// back-off and retransmit, adjusting for the perceived congestion.
if (socket_write_pending_) {
return IPseudoTcpNotify::WR_SUCCESS;
}
auto write_buffer = base::MakeRefCounted<net::IOBufferWithSize>(len);
memcpy(write_buffer->data(), buffer, len);
// Our underlying socket is datagram-oriented, which means it should either
// send exactly as many bytes as we requested, or fail.
int result;
if (socket_) {
result =
socket_->Send(write_buffer.get(), len,
base::BindRepeating(&PseudoTcpAdapter::Core::OnWritten,
base::Unretained(this)));
} else {
result = net::ERR_CONNECTION_CLOSED;
}
if (result == net::ERR_IO_PENDING) {
socket_write_pending_ = true;
return IPseudoTcpNotify::WR_SUCCESS;
} else if (result == net::ERR_MSG_TOO_BIG) {
return IPseudoTcpNotify::WR_TOO_LARGE;
} else if (result < 0) {
return IPseudoTcpNotify::WR_FAIL;
} else {
return IPseudoTcpNotify::WR_SUCCESS;
}
}
void PseudoTcpAdapter::Core::DoReadFromSocket() {
if (!socket_read_buffer_.get()) {
socket_read_buffer_ =
base::MakeRefCounted<net::IOBufferWithSize>(kReadBufferSize);
}
int result = 1;
while (socket_ && result > 0) {
result = socket_->Recv(socket_read_buffer_.get(), kReadBufferSize,
base::BindRepeating(&PseudoTcpAdapter::Core::OnRead,
base::Unretained(this)));
if (result != net::ERR_IO_PENDING) {
HandleReadResults(result);
}
}
}
void PseudoTcpAdapter::Core::HandleReadResults(int result) {
if (result <= 0) {
LOG(ERROR) << "Read returned " << result;
return;
}
// TODO(wez): Disconnect on failure of NotifyPacket?
pseudo_tcp_.NotifyPacket(socket_read_buffer_->data(), result);
AdjustClock();
CheckWriteComplete();
}
void PseudoTcpAdapter::Core::OnRead(int result) {
// Reference the Core in case a callback deletes the adapter.
scoped_refptr<Core> core(this);
HandleReadResults(result);
if (result >= 0) {
DoReadFromSocket();
}
}
void PseudoTcpAdapter::Core::OnWritten(int result) {
// Reference the Core in case a callback deletes the adapter.
scoped_refptr<Core> core(this);
socket_write_pending_ = false;
if (result < 0) {
LOG(WARNING) << "Write failed. Error code: " << result;
}
}
void PseudoTcpAdapter::Core::AdjustClock() {
long timeout = 0;
if (pseudo_tcp_.GetNextClock(PseudoTcp::Now(), timeout)) {
timer_.Stop();
timer_.Start(FROM_HERE, base::Milliseconds(std::max(timeout, 0L)), this,
&PseudoTcpAdapter::Core::HandleTcpClock);
}
}
void PseudoTcpAdapter::Core::HandleTcpClock() {
// Reference the Core in case a callback deletes the adapter.
scoped_refptr<Core> core(this);
pseudo_tcp_.NotifyClock(PseudoTcp::Now());
AdjustClock();
CheckWriteComplete();
}
void PseudoTcpAdapter::Core::CheckWriteComplete() {
if (!write_callback_.is_null() && waiting_write_position_) {
if (pseudo_tcp_.GetBytesBufferedNotSent() == 0) {
waiting_write_position_ = false;
write_buffer_.reset();
std::move(write_callback_).Run(last_write_result_);
}
}
}
// Public interface implementation.
PseudoTcpAdapter::PseudoTcpAdapter(std::unique_ptr<P2PDatagramSocket> socket)
: core_(new Core(std::move(socket))) {}
PseudoTcpAdapter::~PseudoTcpAdapter() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
// Make sure that the underlying socket is destroyed before PseudoTcp.
core_->DeleteSocket();
}
int PseudoTcpAdapter::Read(const scoped_refptr<net::IOBuffer>& buffer,
int buffer_size,
net::CompletionOnceCallback callback) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return core_->Read(buffer, buffer_size, std::move(callback));
}
int PseudoTcpAdapter::Write(
const scoped_refptr<net::IOBuffer>& buffer,
int buffer_size,
net::CompletionOnceCallback callback,
const net::NetworkTrafficAnnotationTag& traffic_annotation) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return core_->Write(buffer, buffer_size, std::move(callback),
traffic_annotation);
}
int PseudoTcpAdapter::SetReceiveBufferSize(int32_t size) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
core_->SetReceiveBufferSize(size);
return net::OK;
}
int PseudoTcpAdapter::SetSendBufferSize(int32_t size) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
core_->SetSendBufferSize(size);
return net::OK;
}
net::CompletionOnceCallback PseudoTcpAdapter::Connect(
net::CompletionOnceCallback callback) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return core_->Connect(std::move(callback));
}
void PseudoTcpAdapter::SetAckDelay(int delay_ms) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
core_->SetAckDelay(delay_ms);
}
void PseudoTcpAdapter::SetNoDelay(bool no_delay) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
core_->SetNoDelay(no_delay);
}
void PseudoTcpAdapter::SetWriteWaitsForSend(bool write_waits_for_send) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
core_->SetWriteWaitsForSend(write_waits_for_send);
}
} // namespace remoting::protocol
|