Merge remote-tracking branch 'upstream/master'

src/network/core/CMakeLists.txt

@@ -0,0 +1,27 @@
+add_files(
+    address.cpp
+    address.h
+    config.h
+    core.cpp
+    core.h
+    game.h
+    host.cpp
+    host.h
+    os_abstraction.h
+    packet.cpp
+    packet.h
+    tcp.cpp
+    tcp.h
+    tcp_admin.cpp
+    tcp_admin.h
+    tcp_connect.cpp
+    tcp_content.cpp
+    tcp_content.h
+    tcp_game.cpp
+    tcp_game.h
+    tcp_http.cpp
+    tcp_http.h
+    tcp_listen.h
+    udp.cpp
+    udp.h
+)

src/network/core/address.cpp

@@ -96,12 +96,11 @@ void NetworkAddress::GetAddressAsString(char *buffer, const char *last, bool wit
  * Get the address as a string, e.g. 127.0.0.1:12345.
  * @param with_family whether to add the family (e.g. IPvX).
  * @return the address
- * @note NOT thread safe
  */
-const char *NetworkAddress::GetAddressAsString(bool with_family)
+std::string NetworkAddress::GetAddressAsString(bool with_family)
 {
 	/* 6 = for the : and 5 for the decimal port number */
-	static char buf[NETWORK_HOSTNAME_LENGTH + 6 + 7];
+	char buf[NETWORK_HOSTNAME_LENGTH + 6 + 7];
 	this->GetAddressAsString(buf, lastof(buf), with_family);
 	return buf;
 }
@@ -268,6 +267,18 @@ SOCKET NetworkAddress::Resolve(int family, int socktype, int flags, SocketList *
 			this->address_length = (int)runp->ai_addrlen;
 			assert(sizeof(this->address) >= runp->ai_addrlen);
 			memcpy(&this->address, runp->ai_addr, runp->ai_addrlen);
+#ifdef __EMSCRIPTEN__
+			/* Emscripten doesn't zero sin_zero, but as we compare addresses
+			 * to see if they are the same address, we need them to be zero'd.
+			 * Emscripten is, as far as we know, the only OS not doing this.
+			 *
+			 * https://github.com/emscripten-core/emscripten/issues/12998
+			 */
+			if (this->address.ss_family == AF_INET) {
+				sockaddr_in *address_ipv4 = (sockaddr_in *)&this->address;
+				memset(address_ipv4->sin_zero, 0, sizeof(address_ipv4->sin_zero));
+			}
+#endif
 			break;
 		}
 
@@ -289,7 +300,8 @@ static SOCKET ConnectLoopProc(addrinfo *runp)
 {
 	const char *type = NetworkAddress::SocketTypeAsString(runp->ai_socktype);
 	const char *family = NetworkAddress::AddressFamilyAsString(runp->ai_family);
-	const char *address = NetworkAddress(runp->ai_addr, (int)runp->ai_addrlen).GetAddressAsString();
+	char address[NETWORK_HOSTNAME_LENGTH + 6 + 7];
+	NetworkAddress(runp->ai_addr, (int)runp->ai_addrlen).GetAddressAsString(address, lastof(address));
 
 	SOCKET sock = socket(runp->ai_family, runp->ai_socktype, runp->ai_protocol);
 	if (sock == INVALID_SOCKET) {
@@ -299,7 +311,15 @@ static SOCKET ConnectLoopProc(addrinfo *runp)
 
 	if (!SetNoDelay(sock)) DEBUG(net, 1, "[%s] setting TCP_NODELAY failed", type);
 
-	if (connect(sock, runp->ai_addr, (int)runp->ai_addrlen) != 0) {
+	int err = connect(sock, runp->ai_addr, (int)runp->ai_addrlen);
+#ifdef __EMSCRIPTEN__
+	/* Emscripten is asynchronous, and as such a connect() is still in
+	 * progress by the time the call returns. */
+	if (err != 0 && errno != EINPROGRESS)
+#else
+	if (err != 0)
+#endif
+	{
 		DEBUG(net, 1, "[%s] could not connect %s socket: %s", type, family, strerror(errno));
 		closesocket(sock);
 		return INVALID_SOCKET;
@@ -319,7 +339,7 @@ static SOCKET ConnectLoopProc(addrinfo *runp)
  */
 SOCKET NetworkAddress::Connect()
 {
-	DEBUG(net, 1, "Connecting to %s", this->GetAddressAsString());
+	DEBUG(net, 1, "Connecting to %s", this->GetAddressAsString().c_str());
 
 	return this->Resolve(AF_UNSPEC, SOCK_STREAM, AI_ADDRCONFIG, nullptr, ConnectLoopProc);
 }
@@ -333,7 +353,8 @@ static SOCKET ListenLoopProc(addrinfo *runp)
 {
 	const char *type = NetworkAddress::SocketTypeAsString(runp->ai_socktype);
 	const char *family = NetworkAddress::AddressFamilyAsString(runp->ai_family);
-	const char *address = NetworkAddress(runp->ai_addr, (int)runp->ai_addrlen).GetAddressAsString();
+	char address[NETWORK_HOSTNAME_LENGTH + 6 + 7];
+	NetworkAddress(runp->ai_addr, (int)runp->ai_addrlen).GetAddressAsString(address, lastof(address));
 
 	SOCKET sock = socket(runp->ai_family, runp->ai_socktype, runp->ai_protocol);
 	if (sock == INVALID_SOCKET) {

src/network/core/address.h

@@ -15,6 +15,8 @@
 #include "../../string_func.h"
 #include "../../core/smallmap_type.hpp"
 
+#include <string>
+
 class NetworkAddress;
 typedef std::vector<NetworkAddress> NetworkAddressList; ///< Type for a list of addresses.
 typedef SmallMap<NetworkAddress, SOCKET> SocketList;    ///< Type for a mapping between address and socket.
@@ -91,7 +93,7 @@ public:
 
 	const char *GetHostname();
 	void GetAddressAsString(char *buffer, const char *last, bool with_family = true);
-	const char *GetAddressAsString(bool with_family = true);
+	std::string GetAddressAsString(bool with_family = true);
 	const sockaddr_storage *GetAddress();
 
 	/**

src/network/core/os_abstraction.h

@@ -83,6 +83,16 @@ typedef unsigned long in_addr_t;
 #	include <errno.h>
 #	include <sys/time.h>
 #	include <netdb.h>
+
+#   if defined(__EMSCRIPTEN__)
+/* Emscripten doesn't support AI_ADDRCONFIG and errors out on it. */
+#		undef AI_ADDRCONFIG
+#		define AI_ADDRCONFIG 0
+/* Emscripten says it supports FD_SETSIZE fds, but it really only supports 64.
+ * https://github.com/emscripten-core/emscripten/issues/1711 */
+#		undef FD_SETSIZE
+#		define FD_SETSIZE 64
+#   endif
 #endif /* UNIX */
 
 /* OS/2 stuff */
@@ -141,6 +151,28 @@ typedef unsigned long in_addr_t;
 
 #endif /* OS/2 */
 
+#ifdef __EMSCRIPTEN__
+/**
+ * Emscripten doesn't set 'addrlen' for accept(), getsockname(), getpeername()
+ * and recvfrom(), which confuses other functions and causes them to crash.
+ * This function needs to be called after these four functions to make sure
+ * 'addrlen' is patched up.
+ *
+ * https://github.com/emscripten-core/emscripten/issues/12996
+ *
+ * @param address The address returned by those four functions.
+ * @return The correct value for addrlen.
+ */
+static inline socklen_t FixAddrLenForEmscripten(struct sockaddr_storage &address)
+{
+	switch (address.ss_family) {
+		case AF_INET6: return sizeof(struct sockaddr_in6);
+		case AF_INET: return sizeof(struct sockaddr_in);
+		default: NOT_REACHED();
+	}
+}
+#endif
+
 /**
  * Try to set the socket into non-blocking mode.
  * @param d The socket to set the non-blocking more for.
@@ -148,12 +180,16 @@ typedef unsigned long in_addr_t;
  */
 static inline bool SetNonBlocking(SOCKET d)
 {
-#ifdef _WIN32
-	u_long nonblocking = 1;
+#ifdef __EMSCRIPTEN__
+	return true;
 #else
+#	ifdef _WIN32
+	u_long nonblocking = 1;
+#	else
 	int nonblocking = 1;
-#endif
+#	endif
 	return ioctlsocket(d, FIONBIO, &nonblocking) == 0;
+#endif
 }
 
 /**
@@ -163,14 +199,18 @@ static inline bool SetNonBlocking(SOCKET d)
  */
 static inline bool SetNoDelay(SOCKET d)
 {
+#ifdef __EMSCRIPTEN__
+	return true;
+#else
 	/* XXX should this be done at all? */
 	int b = 1;
 	/* The (const char*) cast is needed for windows */
 	return setsockopt(d, IPPROTO_TCP, TCP_NODELAY, (const char*)&b, sizeof(b)) == 0;
+#endif
 }
 
 /* Make sure these structures have the size we expect them to be */
-assert_compile(sizeof(in_addr)  ==  4); ///< IPv4 addresses should be 4 bytes.
-assert_compile(sizeof(in6_addr) == 16); ///< IPv6 addresses should be 16 bytes.
+static_assert(sizeof(in_addr)  ==  4); ///< IPv4 addresses should be 4 bytes.
+static_assert(sizeof(in6_addr) == 16); ///< IPv6 addresses should be 16 bytes.
 
 #endif /* NETWORK_CORE_OS_ABSTRACTION_H */

src/network/core/tcp.h

@@ -15,6 +15,8 @@
 #include "address.h"
 #include "packet.h"
 
+#include <atomic>
+
 /** The states of sending the packets. */
 enum SendPacketsState {
 	SPS_CLOSED,      ///< The connection got closed.
@@ -61,8 +63,8 @@ public:
  */
 class TCPConnecter {
 private:
-	bool connected;             ///< Whether we succeeded in making the connection
-	bool aborted;               ///< Whether we bailed out (i.e. connection making failed)
+	std::atomic<bool> connected;///< Whether we succeeded in making the connection
+	std::atomic<bool> aborted;  ///< Whether we bailed out (i.e. connection making failed)
 	bool killed;                ///< Whether we got killed
 	SOCKET sock;                ///< The socket we're connecting with
 

src/network/core/tcp_admin.cpp

@@ -18,10 +18,10 @@
 #include "../../safeguards.h"
 
 /* Make sure that these enums match. */
-assert_compile((int)CRR_MANUAL    == (int)ADMIN_CRR_MANUAL);
-assert_compile((int)CRR_AUTOCLEAN == (int)ADMIN_CRR_AUTOCLEAN);
-assert_compile((int)CRR_BANKRUPT  == (int)ADMIN_CRR_BANKRUPT);
-assert_compile((int)CRR_END       == (int)ADMIN_CRR_END);
+static_assert((int)CRR_MANUAL    == (int)ADMIN_CRR_MANUAL);
+static_assert((int)CRR_AUTOCLEAN == (int)ADMIN_CRR_AUTOCLEAN);
+static_assert((int)CRR_BANKRUPT  == (int)ADMIN_CRR_BANKRUPT);
+static_assert((int)CRR_END       == (int)ADMIN_CRR_END);
 
 /**
  * Create the admin handler for the given socket.
@@ -115,6 +115,7 @@ NetworkRecvStatus NetworkAdminSocketHandler::ReceivePackets()
 	Packet *p;
 	while ((p = this->ReceivePacket()) != nullptr) {
 		NetworkRecvStatus res = this->HandlePacket(p);
+		delete p;
 		if (res != NETWORK_RECV_STATUS_OKAY) return res;
 	}
 

src/network/core/tcp_admin.h

@@ -134,7 +134,7 @@ protected:
 
 	/**
 	 * Register updates to be sent at certain frequencies (as announced in the PROTOCOL packet):
-	 * uint16  Update type (see #AdminUpdateType).
+	 * uint16  Update type (see #AdminUpdateType). Note integer type - see "Certain Packet Information" in docs/admin_network.md.
 	 * uint16  Update frequency (see #AdminUpdateFrequency), setting #ADMIN_FREQUENCY_POLL is always ignored.
 	 * @param p The packet that was just received.
 	 * @return The state the network should have.
@@ -143,7 +143,7 @@ protected:
 
 	/**
 	 * Poll the server for certain updates, an invalid poll (e.g. not existent id) gets silently dropped:
-	 * uint8   #AdminUpdateType the server should answer for, only if #AdminUpdateFrequency #ADMIN_FREQUENCY_POLL is advertised in the PROTOCOL packet.
+	 * uint8   #AdminUpdateType the server should answer for, only if #AdminUpdateFrequency #ADMIN_FREQUENCY_POLL is advertised in the PROTOCOL packet. Note integer type - see "Certain Packet Information" in docs/admin_network.md.
 	 * uint32  ID relevant to the packet type, e.g.
 	 *          - the client ID for #ADMIN_UPDATE_CLIENT_INFO. Use UINT32_MAX to show all clients.
 	 *          - the company ID for #ADMIN_UPDATE_COMPANY_INFO. Use UINT32_MAX to show all companies.

src/network/core/tcp_connect.cpp

@@ -66,19 +66,21 @@ void TCPConnecter::Connect()
 {
 	for (auto iter = _tcp_connecters.begin(); iter < _tcp_connecters.end(); /* nothing */) {
 		TCPConnecter *cur = *iter;
-		if ((cur->connected || cur->aborted) && cur->killed) {
+		const bool connected = cur->connected.load();
+		const bool aborted = cur->aborted.load();
+		if ((connected || aborted) && cur->killed) {
 			iter = _tcp_connecters.erase(iter);
 			if (cur->sock != INVALID_SOCKET) closesocket(cur->sock);
 			delete cur;
 			continue;
 		}
-		if (cur->connected) {
+		if (connected) {
 			iter = _tcp_connecters.erase(iter);
 			cur->OnConnect(cur->sock);
 			delete cur;
 			continue;
 		}
-		if (cur->aborted) {
+		if (aborted) {
 			iter = _tcp_connecters.erase(iter);
 			cur->OnFailure();
 			delete cur;

src/network/core/tcp_content.cpp

@@ -171,9 +171,9 @@ bool NetworkContentSocketHandler::HandlePacket(Packet *p)
 
 		default:
 			if (this->HasClientQuit()) {
-				DEBUG(net, 0, "[tcp/content] received invalid packet type %d from %s", type, this->client_addr.GetAddressAsString());
+				DEBUG(net, 0, "[tcp/content] received invalid packet type %d from %s", type, this->client_addr.GetAddressAsString().c_str());
 			} else {
-				DEBUG(net, 0, "[tcp/content] received illegal packet from %s", this->client_addr.GetAddressAsString());
+				DEBUG(net, 0, "[tcp/content] received illegal packet from %s", this->client_addr.GetAddressAsString().c_str());
 			}
 			return false;
 	}
@@ -224,7 +224,7 @@ bool NetworkContentSocketHandler::ReceivePackets()
  */
 bool NetworkContentSocketHandler::ReceiveInvalidPacket(PacketContentType type)
 {
-	DEBUG(net, 0, "[tcp/content] received illegal packet type %d from %s", type, this->client_addr.GetAddressAsString());
+	DEBUG(net, 0, "[tcp/content] received illegal packet type %d from %s", type, this->client_addr.GetAddressAsString().c_str());
 	return false;
 }
 

src/network/core/tcp_http.cpp

@@ -250,8 +250,8 @@ int NetworkHTTPSocketHandler::Receive()
 
 		/* Wait till we read the end-of-header identifier */
 		if (this->recv_length == 0) {
-			int read = this->recv_pos + res;
-			int end = min(read, lengthof(this->recv_buffer) - 1);
+			ssize_t read = this->recv_pos + res;
+			ssize_t end = std::min<ssize_t>(read, lengthof(this->recv_buffer) - 1);
 
 			/* Do a 'safe' search for the end of the header. */
 			char prev = this->recv_buffer[end];
@@ -272,7 +272,7 @@ int NetworkHTTPSocketHandler::Receive()
 				this->recv_length = ret;
 
 				end_of_header += strlen(END_OF_HEADER);
-				int len = min(read - (end_of_header - this->recv_buffer), res);
+				int len = std::min(read - (end_of_header - this->recv_buffer), res);
 				if (len != 0) {
 					this->callback->OnReceiveData(end_of_header, len);
 					this->recv_length -= len;
@@ -281,7 +281,7 @@ int NetworkHTTPSocketHandler::Receive()
 				this->recv_pos = 0;
 			}
 		} else {
-			res = min(this->recv_length, res);
+			res = std::min<ssize_t>(this->recv_length, res);
 			/* Receive whatever we're expecting. */
 			this->callback->OnReceiveData(this->recv_buffer, res);
 			this->recv_length -= res;

src/network/core/tcp_listen.h

@@ -42,6 +42,9 @@ public:
 			socklen_t sin_len = sizeof(sin);
 			SOCKET s = accept(ls, (struct sockaddr*)&sin, &sin_len);
 			if (s == INVALID_SOCKET) return;
+#ifdef __EMSCRIPTEN__
+			sin_len = FixAddrLenForEmscripten(sin);
+#endif
 
 			SetNonBlocking(s); // XXX error handling?
 

src/network/core/udp.cpp

@@ -100,10 +100,10 @@ void NetworkUDPSocketHandler::SendPacket(Packet *p, NetworkAddress *recv, bool a
 
 		/* Send the buffer */
 		int res = sendto(s.second, (const char*)p->buffer, p->size, 0, (const struct sockaddr *)send.GetAddress(), send.GetAddressLength());
-		DEBUG(net, 7, "[udp] sendto(%s)", send.GetAddressAsString());
+		DEBUG(net, 7, "[udp] sendto(%s)", send.GetAddressAsString().c_str());
 
 		/* Check for any errors, but ignore it otherwise */
-		if (res == -1) DEBUG(net, 1, "[udp] sendto(%s) failed with: %i", send.GetAddressAsString(), GET_LAST_ERROR());
+		if (res == -1) DEBUG(net, 1, "[udp] sendto(%s) failed with: %i", send.GetAddressAsString().c_str(), GET_LAST_ERROR());
 
 		if (!all) break;
 	}
@@ -129,6 +129,9 @@ void NetworkUDPSocketHandler::ReceivePackets()
 			/* Did we get the bytes for the base header of the packet? */
 			if (nbytes <= 0) break;    // No data, i.e. no packet
 			if (nbytes <= 2) continue; // Invalid data; try next packet
+#ifdef __EMSCRIPTEN__
+			client_len = FixAddrLenForEmscripten(client_addr);
+#endif
 
 			NetworkAddress address(client_addr, client_len);
 			p.PrepareToRead();
@@ -136,7 +139,7 @@ void NetworkUDPSocketHandler::ReceivePackets()
 			/* If the size does not match the packet must be corrupted.
 			 * Otherwise it will be marked as corrupted later on. */
 			if (nbytes != p.size) {
-				DEBUG(net, 1, "received a packet with mismatching size from %s", address.GetAddressAsString());
+				DEBUG(net, 1, "received a packet with mismatching size from %s", address.GetAddressAsString().c_str());
 				continue;
 			}
 
@@ -313,9 +316,9 @@ void NetworkUDPSocketHandler::HandleUDPPacket(Packet *p, NetworkAddress *client_
 
 		default:
 			if (this->HasClientQuit()) {
-				DEBUG(net, 0, "[udp] received invalid packet type %d from %s", type, client_addr->GetAddressAsString());
+				DEBUG(net, 0, "[udp] received invalid packet type %d from %s", type, client_addr->GetAddressAsString().c_str());
 			} else {
-				DEBUG(net, 0, "[udp] received illegal packet from %s", client_addr->GetAddressAsString());
+				DEBUG(net, 0, "[udp] received illegal packet from %s", client_addr->GetAddressAsString().c_str());
 			}
 			break;
 	}
@@ -328,7 +331,7 @@ void NetworkUDPSocketHandler::HandleUDPPacket(Packet *p, NetworkAddress *client_
  */
 void NetworkUDPSocketHandler::ReceiveInvalidPacket(PacketUDPType type, NetworkAddress *client_addr)
 {
-	DEBUG(net, 0, "[udp] received packet type %d on wrong port from %s", type, client_addr->GetAddressAsString());
+	DEBUG(net, 0, "[udp] received packet type %d on wrong port from %s", type, client_addr->GetAddressAsString().c_str());
 }
 
 void NetworkUDPSocketHandler::Receive_CLIENT_FIND_SERVER(Packet *p, NetworkAddress *client_addr) { this->ReceiveInvalidPacket(PACKET_UDP_CLIENT_FIND_SERVER, client_addr); }