mirror of
https://github.com/nestriness/cdc-file-transfer.git
synced 2026-01-30 12:25:35 +02:00
[cdc_rsync] Move sockets to common (#95)
There are no real changes, just moving files around. Sockets will be used in the future to find available ports in cdc_stream. Therefore, they need to be in common.
This commit is contained in:
@@ -22,7 +22,7 @@ cc_test(
|
||||
srcs = ["file_deleter_and_sender_test.cc"],
|
||||
deps = [
|
||||
":file_deleter_and_sender",
|
||||
"//cdc_rsync/base:fake_socket",
|
||||
"//common:fake_socket",
|
||||
"//common:status_test_macros",
|
||||
"//common:test_main",
|
||||
"@com_google_googletest//:gtest",
|
||||
@@ -95,7 +95,6 @@ cc_binary(
|
||||
":file_diff_generator",
|
||||
":file_finder",
|
||||
":file_info",
|
||||
":server_socket",
|
||||
":unzstd_stream",
|
||||
"//cdc_rsync/base:cdc_interface",
|
||||
"//cdc_rsync/base:message_pump",
|
||||
@@ -105,6 +104,7 @@ cc_binary(
|
||||
"//common:gamelet_component",
|
||||
"//common:log",
|
||||
"//common:path_filter",
|
||||
"//common:server_socket",
|
||||
"//common:status",
|
||||
"//common:stopwatch",
|
||||
"//common:threadpool",
|
||||
@@ -124,33 +124,13 @@ cc_library(
|
||||
hdrs = ["file_info.h"],
|
||||
)
|
||||
|
||||
cc_library(
|
||||
name = "server_socket",
|
||||
srcs = ["server_socket.cc"],
|
||||
hdrs = ["server_socket.h"],
|
||||
linkopts = select({
|
||||
"//tools:windows": [
|
||||
"/DEFAULTLIB:Ws2_32.lib", # Sockets, e.g. recv, send, WSA*.
|
||||
],
|
||||
"//conditions:default": [],
|
||||
}),
|
||||
deps = [
|
||||
"//cdc_rsync/base:socket",
|
||||
"//common:log",
|
||||
"//common:status",
|
||||
"//common:util",
|
||||
"@com_google_absl//absl/status",
|
||||
"@com_google_absl//absl/status:statusor",
|
||||
],
|
||||
)
|
||||
|
||||
cc_library(
|
||||
name = "unzstd_stream",
|
||||
srcs = ["unzstd_stream.cc"],
|
||||
hdrs = ["unzstd_stream.h"],
|
||||
deps = [
|
||||
"//cdc_rsync/base:message_pump",
|
||||
"//cdc_rsync/base:socket",
|
||||
"//common:socket",
|
||||
"//common:status",
|
||||
"@com_github_zstd//:zstd",
|
||||
"@com_google_absl//absl/status",
|
||||
|
||||
@@ -19,10 +19,10 @@
|
||||
#include "cdc_rsync/protos/messages.pb.h"
|
||||
#include "cdc_rsync_server/file_deleter_and_sender.h"
|
||||
#include "cdc_rsync_server/file_finder.h"
|
||||
#include "cdc_rsync_server/server_socket.h"
|
||||
#include "cdc_rsync_server/unzstd_stream.h"
|
||||
#include "common/log.h"
|
||||
#include "common/path.h"
|
||||
#include "common/server_socket.h"
|
||||
#include "common/status.h"
|
||||
#include "common/status_macros.h"
|
||||
#include "common/stopwatch.h"
|
||||
|
||||
@@ -14,8 +14,8 @@
|
||||
|
||||
#include "cdc_rsync_server/file_deleter_and_sender.h"
|
||||
|
||||
#include "cdc_rsync/base/fake_socket.h"
|
||||
#include "cdc_rsync/base/message_pump.h"
|
||||
#include "common/fake_socket.h"
|
||||
#include "common/log.h"
|
||||
#include "common/path.h"
|
||||
#include "common/status_test_macros.h"
|
||||
|
||||
@@ -1,355 +0,0 @@
|
||||
// Copyright 2022 Google LLC
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
#include "cdc_rsync_server/server_socket.h"
|
||||
|
||||
#include "common/log.h"
|
||||
#include "common/platform.h"
|
||||
#include "common/status.h"
|
||||
#include "common/util.h"
|
||||
|
||||
#if PLATFORM_WINDOWS
|
||||
|
||||
#include <winsock2.h>
|
||||
#include <ws2tcpip.h>
|
||||
|
||||
#elif PLATFORM_LINUX
|
||||
|
||||
#include <netdb.h>
|
||||
#include <netinet/in.h>
|
||||
#include <sys/socket.h>
|
||||
#include <sys/types.h>
|
||||
#include <unistd.h>
|
||||
|
||||
#include <cerrno>
|
||||
|
||||
#endif
|
||||
|
||||
namespace cdc_ft {
|
||||
namespace {
|
||||
|
||||
#if PLATFORM_WINDOWS
|
||||
|
||||
using SocketType = SOCKET;
|
||||
using SockAddrType = SOCKADDR;
|
||||
constexpr SocketType kInvalidSocket = INVALID_SOCKET;
|
||||
constexpr int kSocketError = SOCKET_ERROR;
|
||||
constexpr int kSendingEnd = SD_SEND;
|
||||
|
||||
constexpr int kErrAgain = WSAEWOULDBLOCK; // There's no EAGAIN on Windows.
|
||||
constexpr int kErrWouldBlock = WSAEWOULDBLOCK;
|
||||
constexpr int kErrAddrInUse = WSAEADDRINUSE;
|
||||
|
||||
int GetLastError() { return WSAGetLastError(); }
|
||||
std::string GetErrorStr(int err) { return Util::GetWin32Error(err); }
|
||||
void Close(SocketType* socket) {
|
||||
if (*socket != kInvalidSocket) {
|
||||
closesocket(*socket);
|
||||
*socket = kInvalidSocket;
|
||||
}
|
||||
}
|
||||
|
||||
// Not necessary on Windows.
|
||||
#define HANDLE_EINTR(x) (x)
|
||||
|
||||
#elif PLATFORM_LINUX
|
||||
|
||||
using SocketType = int;
|
||||
using SockAddrType = sockaddr;
|
||||
constexpr SocketType kInvalidSocket = -1;
|
||||
constexpr int kSocketError = -1;
|
||||
constexpr int kSendingEnd = SHUT_WR;
|
||||
|
||||
constexpr int kErrAgain = EAGAIN;
|
||||
constexpr int kErrWouldBlock = EWOULDBLOCK;
|
||||
constexpr int kErrAddrInUse = EADDRINUSE;
|
||||
|
||||
int GetLastError() { return errno; }
|
||||
std::string GetErrorStr(int err) { return strerror(err); }
|
||||
void Close(SocketType* socket) {
|
||||
if (*socket != kInvalidSocket) {
|
||||
close(*socket);
|
||||
*socket = kInvalidSocket;
|
||||
}
|
||||
}
|
||||
|
||||
// Keep re-evaluating the expression |x| while it returns EINTR.
|
||||
#define HANDLE_EINTR(x) \
|
||||
({ \
|
||||
decltype(x) eintr_wrapper_result; \
|
||||
do { \
|
||||
eintr_wrapper_result = (x); \
|
||||
} while (eintr_wrapper_result == -1 && errno == EINTR); \
|
||||
eintr_wrapper_result; \
|
||||
})
|
||||
|
||||
#endif
|
||||
|
||||
std::string GetLastErrorStr() { return GetErrorStr(GetLastError()); }
|
||||
|
||||
class AddrInfoReleaser {
|
||||
public:
|
||||
AddrInfoReleaser(addrinfo* addr_infos) : addr_infos_(addr_infos) {}
|
||||
~AddrInfoReleaser() { freeaddrinfo(addr_infos_); }
|
||||
|
||||
private:
|
||||
addrinfo* addr_infos_;
|
||||
};
|
||||
|
||||
} // namespace
|
||||
|
||||
struct ServerSocketInfo {
|
||||
// Listening socket file descriptor (where new connections are accepted).
|
||||
SocketType listen_sock = kInvalidSocket;
|
||||
|
||||
// Connection socket file descriptor (where data is sent to/received from).
|
||||
SocketType conn_sock = kInvalidSocket;
|
||||
};
|
||||
|
||||
ServerSocket::ServerSocket()
|
||||
: Socket(), socket_info_(std::make_unique<ServerSocketInfo>()) {}
|
||||
|
||||
ServerSocket::~ServerSocket() {
|
||||
Disconnect();
|
||||
StopListening();
|
||||
}
|
||||
|
||||
absl::StatusOr<int> ServerSocket::StartListening(int port) {
|
||||
if (socket_info_->listen_sock != kInvalidSocket) {
|
||||
return MakeStatus("Already listening");
|
||||
}
|
||||
|
||||
// Find addrinfos suitable for listening via IPV4 and IPV6.
|
||||
addrinfo hints;
|
||||
addrinfo* addr_infos = nullptr;
|
||||
memset(&hints, 0, sizeof(hints));
|
||||
hints.ai_family = PF_UNSPEC;
|
||||
hints.ai_socktype = SOCK_STREAM;
|
||||
hints.ai_protocol = IPPROTO_TCP;
|
||||
// AI_PASSIVE indicates that the addresses are used with bind(). The returned
|
||||
// addresses will be the unspecified addresses for each family.
|
||||
hints.ai_flags = AI_NUMERICHOST | AI_PASSIVE;
|
||||
int result = getaddrinfo(/*address=*/nullptr, std::to_string(port).c_str(),
|
||||
&hints, &addr_infos);
|
||||
if (result != 0) {
|
||||
return MakeStatus("Getting address infos failed: %s", GetLastErrorStr());
|
||||
}
|
||||
AddrInfoReleaser releaser(addr_infos);
|
||||
|
||||
// Prefer IPV6 sockets. They can also accept IPV4 connections.
|
||||
for (addrinfo* curr = addr_infos; curr; curr = curr->ai_next) {
|
||||
if (curr->ai_family == PF_INET6) {
|
||||
return StartListeningInternal(port, curr);
|
||||
}
|
||||
}
|
||||
|
||||
// Fall back to IPV4 sockets.
|
||||
for (addrinfo* curr = addr_infos; curr; curr = curr->ai_next) {
|
||||
if (curr->ai_family == PF_INET) {
|
||||
return StartListeningInternal(port, curr);
|
||||
}
|
||||
}
|
||||
|
||||
return MakeStatus("No IPV4 and IPV6 network addresses available");
|
||||
}
|
||||
|
||||
absl::StatusOr<int> ServerSocket::StartListeningInternal(int port,
|
||||
addrinfo* addr) {
|
||||
assert(addr->ai_family == PF_INET || addr->ai_family == PF_INET6);
|
||||
const char* family = addr->ai_family == PF_INET ? "IPV4" : "IPV6";
|
||||
|
||||
// Open a socket with the correct address family for this address.
|
||||
LOG_DEBUG("Open %s listen socket", family);
|
||||
socket_info_->listen_sock =
|
||||
socket(addr->ai_family, addr->ai_socktype, addr->ai_protocol);
|
||||
if (socket_info_->listen_sock == kInvalidSocket) {
|
||||
return MakeStatus("Creating %s listen socket failed: %s", family,
|
||||
GetLastErrorStr());
|
||||
}
|
||||
|
||||
// If the program terminates abnormally, the socket might remain in a
|
||||
// TIME_WAIT state and report "address already in use" on bind(). Setting
|
||||
// SO_REUSEADDR works around that. See
|
||||
// https://hea-www.harvard.edu/~fine/Tech/addrinuse.html
|
||||
const int enable = 1;
|
||||
int result =
|
||||
setsockopt(socket_info_->listen_sock, SOL_SOCKET, SO_REUSEADDR,
|
||||
reinterpret_cast<const char*>(&enable), sizeof(enable));
|
||||
if (result == kSocketError) {
|
||||
LOG_DEBUG("Enabling address reusal failed");
|
||||
}
|
||||
|
||||
// Allow ipv4 connections on the ipv6 socket. By default, ipv6 sockets only
|
||||
// allow ipv4 connections on Windows.
|
||||
if (addr->ai_family == PF_INET6) {
|
||||
const int disable = 0;
|
||||
result =
|
||||
setsockopt(socket_info_->listen_sock, IPPROTO_IPV6, IPV6_V6ONLY,
|
||||
reinterpret_cast<const char*>(&disable), sizeof(disable));
|
||||
if (result == kSocketError) {
|
||||
LOG_DEBUG("Disabling IPV6-only failed");
|
||||
}
|
||||
}
|
||||
|
||||
LOG_DEBUG("Bind socket");
|
||||
result = bind(socket_info_->listen_sock, addr->ai_addr,
|
||||
static_cast<int>(addr->ai_addrlen));
|
||||
if (result == kSocketError) {
|
||||
int err = GetLastError();
|
||||
absl::Status status =
|
||||
MakeStatus("Binding to port %i failed: %s", port, GetErrorStr(err));
|
||||
if (err == kErrAddrInUse) {
|
||||
// Happens when two instances are run at the same time. Help callers to
|
||||
// print reasonable errors.
|
||||
status = SetTag(status, Tag::kAddressInUse);
|
||||
}
|
||||
Close(&socket_info_->listen_sock);
|
||||
return status;
|
||||
}
|
||||
|
||||
if (port == 0) {
|
||||
// Find out which port was auto-selected.
|
||||
socklen_t len = addr->ai_addrlen;
|
||||
result = getsockname(socket_info_->listen_sock, addr->ai_addr, &len);
|
||||
if (result == kSocketError) {
|
||||
Close(&socket_info_->listen_sock);
|
||||
return MakeStatus("Getting port failed: %s", GetLastErrorStr());
|
||||
}
|
||||
if (addr->ai_family == PF_INET) {
|
||||
port = ntohs(reinterpret_cast<sockaddr_in*>(addr->ai_addr)->sin_port);
|
||||
} else if (addr->ai_family == PF_INET6) {
|
||||
port = ntohs(reinterpret_cast<sockaddr_in6*>(addr->ai_addr)->sin6_port);
|
||||
}
|
||||
}
|
||||
|
||||
LOG_DEBUG("Listen");
|
||||
result = listen(socket_info_->listen_sock, 1);
|
||||
if (result == kSocketError) {
|
||||
int err = GetLastError();
|
||||
Close(&socket_info_->listen_sock);
|
||||
return MakeStatus("Listening to socket failed: %s", GetErrorStr(err));
|
||||
}
|
||||
|
||||
return port;
|
||||
}
|
||||
|
||||
void ServerSocket::StopListening() {
|
||||
Close(&socket_info_->listen_sock);
|
||||
LOG_INFO("Stopped listening.");
|
||||
}
|
||||
|
||||
absl::Status ServerSocket::WaitForConnection() {
|
||||
if (socket_info_->conn_sock != kInvalidSocket) {
|
||||
return MakeStatus("Already connected");
|
||||
}
|
||||
if (socket_info_->listen_sock == kInvalidSocket) {
|
||||
return MakeStatus("Not listening");
|
||||
}
|
||||
|
||||
socket_info_->conn_sock = accept(socket_info_->listen_sock, nullptr, nullptr);
|
||||
if (socket_info_->conn_sock == kInvalidSocket) {
|
||||
return MakeStatus("Accepting connection failed: %s", GetLastErrorStr());
|
||||
}
|
||||
|
||||
LOG_DEBUG("Client connected");
|
||||
return absl::OkStatus();
|
||||
}
|
||||
|
||||
void ServerSocket::Disconnect() {
|
||||
Close(&socket_info_->conn_sock);
|
||||
LOG_INFO("Disconnected");
|
||||
}
|
||||
|
||||
absl::Status ServerSocket::ShutdownSendingEnd() {
|
||||
int result = shutdown(socket_info_->conn_sock, kSendingEnd);
|
||||
if (result == kSocketError) {
|
||||
return MakeStatus("Socket shutdown failed: %s", GetLastErrorStr());
|
||||
}
|
||||
|
||||
return absl::OkStatus();
|
||||
}
|
||||
|
||||
absl::Status ServerSocket::Send(const void* buffer, size_t size) {
|
||||
const char* curr_ptr = reinterpret_cast<const char*>(buffer);
|
||||
assert(size <= INT_MAX);
|
||||
int bytes_left = static_cast<int>(size);
|
||||
while (bytes_left > 0) {
|
||||
int bytes_written = HANDLE_EINTR(
|
||||
send(socket_info_->conn_sock, curr_ptr, bytes_left, /*flags*/ 0));
|
||||
|
||||
if (bytes_written < 0) {
|
||||
const int err = GetLastError();
|
||||
if (err == kErrAgain || err == kErrWouldBlock) {
|
||||
// Shouldn't happen as the socket should be blocking.
|
||||
LOG_DEBUG("Socket would block");
|
||||
continue;
|
||||
}
|
||||
|
||||
return MakeStatus("Sending to socket failed: %s", GetErrorStr(err));
|
||||
}
|
||||
|
||||
bytes_left -= bytes_written;
|
||||
curr_ptr += bytes_written;
|
||||
}
|
||||
return absl::OkStatus();
|
||||
}
|
||||
|
||||
absl::Status ServerSocket::Receive(void* buffer, size_t size,
|
||||
bool allow_partial_read,
|
||||
size_t* bytes_received) {
|
||||
*bytes_received = 0;
|
||||
if (size == 0) {
|
||||
return absl::OkStatus();
|
||||
}
|
||||
|
||||
char* curr_ptr = static_cast<char*>(buffer);
|
||||
assert(size <= INT_MAX);
|
||||
int bytes_left = size;
|
||||
while (bytes_left > 0) {
|
||||
int bytes_read = HANDLE_EINTR(
|
||||
recv(socket_info_->conn_sock, curr_ptr, bytes_left, /*flags*/ 0));
|
||||
|
||||
if (bytes_read < 0) {
|
||||
const int err = GetLastError();
|
||||
if (err == kErrAgain || err == kErrWouldBlock) {
|
||||
// Shouldn't happen as the socket should be blocking.
|
||||
LOG_DEBUG("Socket would block");
|
||||
continue;
|
||||
}
|
||||
|
||||
return MakeStatus("Receiving from socket failed: %s", GetErrorStr(err));
|
||||
}
|
||||
|
||||
bytes_left -= bytes_read;
|
||||
*bytes_received += bytes_read;
|
||||
curr_ptr += bytes_read;
|
||||
|
||||
if (bytes_read == 0) {
|
||||
// EOF. Make sure we're not in the middle of a message.
|
||||
if (bytes_left < static_cast<int>(size)) {
|
||||
return MakeStatus("EOF after partial read");
|
||||
}
|
||||
|
||||
LOG_DEBUG("EOF() detected");
|
||||
return SetTag(MakeStatus("EOF detected"), Tag::kSocketEof);
|
||||
}
|
||||
|
||||
if (allow_partial_read) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
return absl::OkStatus();
|
||||
}
|
||||
|
||||
} // namespace cdc_ft
|
||||
@@ -1,68 +0,0 @@
|
||||
/*
|
||||
* Copyright 2022 Google LLC
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
#ifndef CDC_RSYNC_SERVER_SERVER_SOCKET_H_
|
||||
#define CDC_RSYNC_SERVER_SERVER_SOCKET_H_
|
||||
|
||||
#include "absl/status/status.h"
|
||||
#include "absl/status/statusor.h"
|
||||
#include "cdc_rsync/base/socket.h"
|
||||
|
||||
struct addrinfo;
|
||||
|
||||
namespace cdc_ft {
|
||||
|
||||
class ServerSocket : public Socket {
|
||||
public:
|
||||
ServerSocket();
|
||||
~ServerSocket();
|
||||
|
||||
// Starts listening for connections on |port|.
|
||||
// Passing 0 as port will bind to any available port.
|
||||
// Returns the port that was bound to.
|
||||
absl::StatusOr<int> StartListening(int port);
|
||||
|
||||
// Stops listening for connections. No-op if already stopped/never started.
|
||||
void StopListening();
|
||||
|
||||
// Waits for a client to connect. Only supports one connection. Repeating
|
||||
// the call with an existing connection results in an error.
|
||||
absl::Status WaitForConnection();
|
||||
|
||||
// Disconnects the client. No-op if not connected.
|
||||
void Disconnect();
|
||||
|
||||
// Shuts down the sending end of the socket. This will interrupt any receive
|
||||
// calls on the client and shut it down.
|
||||
absl::Status ShutdownSendingEnd();
|
||||
|
||||
// Socket:
|
||||
absl::Status Send(const void* buffer, size_t size) override;
|
||||
absl::Status Receive(void* buffer, size_t size, bool allow_partial_read,
|
||||
size_t* bytes_received) override;
|
||||
|
||||
private:
|
||||
// Called by StartListening() for a specific IPV4 or IPV6 |addr_info|.
|
||||
// Passing 0 as port will bind to any available port.
|
||||
// Returns the port that was bound to.
|
||||
absl::StatusOr<int> StartListeningInternal(int port, addrinfo* addr);
|
||||
|
||||
std::unique_ptr<struct ServerSocketInfo> socket_info_;
|
||||
};
|
||||
|
||||
} // namespace cdc_ft
|
||||
|
||||
#endif // CDC_RSYNC_SERVER_SERVER_SOCKET_H_
|
||||
@@ -14,7 +14,7 @@
|
||||
|
||||
#include "cdc_rsync_server/unzstd_stream.h"
|
||||
|
||||
#include "cdc_rsync/base/socket.h"
|
||||
#include "common/socket.h"
|
||||
#include "common/status.h"
|
||||
|
||||
namespace cdc_ft {
|
||||
|
||||
Reference in New Issue
Block a user