os_abstraction.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */
 
#ifndef NETWORK_CORE_OS_ABSTRACTION_H
#define NETWORK_CORE_OS_ABSTRACTION_H
 
class NetworkError {
private:
  int error;                   
  mutable std::string message; 
public:
  NetworkError(int error, std::string_view message = {});
 
  bool HasError() const;
  bool WouldBlock() const;
  bool IsConnectionReset() const;
  bool IsConnectInProgress() const;
  std::string_view AsString() const;
 
  static NetworkError GetLast();
};
 
/* Include standard stuff per OS */
 
/* Windows stuff */
#if defined(_WIN32)
#include <errno.h>
#include <winsock2.h>
#include <ws2tcpip.h>
#include <windows.h>
 
/* Windows has some different names for some types */
typedef unsigned long in_addr_t;
 
/* Handle cross-compilation with --build=*-*-cygwin --host=*-*-mingw32 */
#if defined(__MINGW32__) && !defined(AI_ADDRCONFIG)
# define AI_ADDRCONFIG               0x00000400
#endif
 
#if !(defined(__MINGW32__) || defined(__CYGWIN__))
  /* Windows has some different names for some types */
  typedef SSIZE_T ssize_t;
  typedef int socklen_t;
# define IPPROTO_IPV6 41
#endif /* !(__MINGW32__ && __CYGWIN__) */
#endif /* _WIN32 */
 
/* UNIX stuff */
#if defined(UNIX)
# if defined(OPENBSD) || defined(__NetBSD__)
#   define AI_ADDRCONFIG 0
# endif
# define SOCKET int
# define INVALID_SOCKET -1
# define closesocket close
/* Need this for FIONREAD on solaris */
# define BSD_COMP
 
/* Includes needed for UNIX-like systems */
# include <unistd.h>
# include <sys/ioctl.h>
# include <sys/socket.h>
# include <netinet/in.h>
# include <netinet/tcp.h>
# include <arpa/inet.h>
# include <net/if.h>
# include <ifaddrs.h>
# if !defined(INADDR_NONE)
#   define INADDR_NONE 0xffffffff
# endif
 
# if defined(__GLIBC__) && (__GLIBC__ <= 2) && (__GLIBC_MINOR__ <= 1)
    typedef uint32_t in_addr_t;
# endif
 
# 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
 
/* Haiku says it supports FD_SETSIZE fds, but it really only supports 512. */
#   if defined(__HAIKU__)
#   undef FD_SETSIZE
#   define FD_SETSIZE 512
#   endif
 
#endif /* UNIX */
 
#ifdef __EMSCRIPTEN__
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
 
 
bool SetNonBlocking(SOCKET d);
bool SetNoDelay(SOCKET d);
bool SetReusePort(SOCKET d);
NetworkError GetSocketError(SOCKET d);
 
/* Make sure these structures have the size we expect them to be */
static_assert(sizeof(in_addr)  ==  4); 
static_assert(sizeof(in6_addr) == 16); 
 
struct SocketSender {
  SOCKET sock;
 
  ssize_t operator()(std::span<const uint8_t> buffer)
  {
    return send(this->sock, reinterpret_cast<const char *>(buffer.data()), static_cast<int>(buffer.size()), 0);
  }
};
 
struct SocketReceiver {
  SOCKET sock;
 
  ssize_t operator()(std::span<uint8_t> buffer)
  {
    return recv(this->sock, reinterpret_cast<char *>(buffer.data()), static_cast<int>(buffer.size()), 0);
  }
};
 
#endif /* NETWORK_CORE_OS_ABSTRACTION_H */