/**************************************************************************/
/* net_socket_unix.cpp */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
// Some proprietary Unix-derived platforms don't expose Unix sockets
// so this allows skipping this file to reimplement this API differently.
#if defined(UNIX_ENABLED) && !defined(UNIX_SOCKET_UNAVAILABLE)
#include "net_socket_unix.h"
#include <fcntl.h>
#include <netdb.h>
#include <netinet/in.h>
#include <netinet/tcp.h>
#include <poll.h>
#include <sys/ioctl.h>
#include <sys/socket.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#include <cerrno>
#include <cstdio>
#include <cstdlib>
#ifdef WEB_ENABLED
#include <arpa/inet.h>
#endif
// BSD calls this flag IPV6_JOIN_GROUP
#if !defined(IPV6_ADD_MEMBERSHIP) && defined(IPV6_JOIN_GROUP)
#define IPV6_ADD_MEMBERSHIP IPV6_JOIN_GROUP
#endif
#if !defined(IPV6_DROP_MEMBERSHIP) && defined(IPV6_LEAVE_GROUP)
#define IPV6_DROP_MEMBERSHIP IPV6_LEAVE_GROUP
#endif
size_t NetSocketUnix::_set_addr_storage(struct sockaddr_storage *p_addr, const IPAddress &p_ip, uint16_t p_port, IP::Type p_ip_type) {
memset(p_addr, 0, sizeof(struct sockaddr_storage));
if (p_ip_type == IP::TYPE_IPV6 || p_ip_type == IP::TYPE_ANY) { // IPv6 socket.
// IPv6 only socket with IPv4 address.
ERR_FAIL_COND_V(!p_ip.is_wildcard() && p_ip_type == IP::TYPE_IPV6 && p_ip.is_ipv4(), 0);
struct sockaddr_in6 *addr6 = (struct sockaddr_in6 *)p_addr;
addr6->sin6_family = AF_INET6;
addr6->sin6_port = htons(p_port);
if (p_ip.is_valid()) {
memcpy(&addr6->sin6_addr.s6_addr, p_ip.get_ipv6(), 16);
} else {
addr6->sin6_addr = in6addr_any;
}
return sizeof(sockaddr_in6);
} else { // IPv4 socket.
// IPv4 socket with IPv6 address.
ERR_FAIL_COND_V(!p_ip.is_wildcard() && !p_ip.is_ipv4(), 0);
struct sockaddr_in *addr4 = (struct sockaddr_in *)p_addr;
addr4->sin_family = AF_INET;
addr4->sin_port = htons(p_port); // Short, network byte order.
if (p_ip.is_valid()) {
memcpy(&addr4->sin_addr.s_addr, p_ip.get_ipv4(), 4);
} else {
addr4->sin_addr.s_addr = INADDR_ANY;
}
return sizeof(sockaddr_in);
}
}
socklen_t NetSocketUnix::_unix_set_sockaddr(struct sockaddr_un *p_addr, const CharString &p_path) {
memset(p_addr, 0, sizeof(struct sockaddr_un));
p_addr->sun_family = AF_UNIX;
// Path must not exceed maximum path length for Unix domain socket
size_t path_len = p_path.length();
ERR_FAIL_COND_V(path_len >= sizeof(p_addr->sun_path) - 1, 0);
// Regular file system socket
memcpy(p_addr->sun_path, p_path.get_data(), path_len);
p_addr->sun_path[path_len] = '\0';
return sizeof(struct sockaddr_un);
}
void NetSocketUnix::_set_ip_port(struct sockaddr_storage *p_addr, IPAddress *r_ip, uint16_t *r_port) {
if (p_addr->ss_family == AF_INET) {
struct sockaddr_in *addr4 = (struct sockaddr_in *)p_addr;
if (r_ip) {
r_ip->set_ipv4((uint8_t *)&(addr4->sin_addr.s_addr));
}
if (r_port) {
*r_port = ntohs(addr4->sin_port);
}
} else if (p_addr->ss_family == AF_INET6) {
struct sockaddr_in6 *addr6 = (struct sockaddr_in6 *)p_addr;
if (r_ip) {
r_ip->set_ipv6(addr6->sin6_addr.s6_addr);
}
if (r_port) {
*r_port = ntohs(addr6->sin6_port);
}
}
}
Ref<NetSocket> NetSocketUnix::_create_func() {
return memnew(NetSocketUnix);
}
void NetSocketUnix::make_default() {
_create = _create_func;
}
void NetSocketUnix::cleanup() {
}
NetSocketUnix::NetSocketUnix() {
}
NetSocketUnix::~NetSocketUnix() {
close();
}
// Silence a warning reported in GH-27594.
// EAGAIN and EWOULDBLOCK have the same value on most platforms, but it's not guaranteed.
GODOT_GCC_WARNING_PUSH_AND_IGNORE("-Wlogical-op")
NetSocketUnix::NetError NetSocketUnix::_get_socket_error() const {
if (errno == EISCONN) {
return ERR_NET_IS_CONNECTED;
}
if (errno == EINPROGRESS || errno == EALREADY) {
return ERR_NET_IN_PROGRESS;
}
if (errno == EAGAIN || errno == EWOULDBLOCK) {
return ERR_NET_WOULD_BLOCK;
}
if (errno == EADDRINUSE || errno == EINVAL || errno == EADDRNOTAVAIL) {
return ERR_NET_ADDRESS_INVALID_OR_UNAVAILABLE;
}
if (errno == EACCES) {
return ERR_NET_UNAUTHORIZED;
}
if (errno == ENOBUFS) {
return ERR_NET_BUFFER_TOO_SMALL;
}
print_verbose("Socket error: " + itos(errno) + ".");
return ERR_NET_OTHER;
}
GODOT_GCC_WARNING_POP
bool NetSocketUnix::_can_use_ip(const IPAddress &p_ip, const bool p_for_bind) const {
if (p_for_bind && !(p_ip.is_valid() || p_ip.is_wildcard())) {
return false;
} else if (!p_for_bind && !p_ip.is_valid()) {
return false;
}
// Check if socket support this IP type.
IP::Type type = p_ip.is_ipv4() ? IP::TYPE_IPV4 : IP::TYPE_IPV6;
return !(_ip_type != IP::TYPE_ANY && !p_ip.is_wildcard() && _ip_type != type);
}
bool NetSocketUnix::_can_use_path(const CharString &p_path) const {
// Path must not exceed maximum path length for Unix domain socket
return !p_path.is_empty() && (size_t)p_path.length() < sizeof(((sockaddr_un *)nullptr)->sun_path);
}
_FORCE_INLINE_ Error NetSocketUnix::_change_multicast_group(IPAddress p_ip, String p_if_name, bool p_add) {
ERR_FAIL_COND_V(!is_open(), ERR_UNCONFIGURED);
ERR_FAIL_COND_V(_family != Family::INET, ERR_UNAVAILABLE);
ERR_FAIL_COND_V(!_can_use_ip(p_ip, false), ERR_INVALID_PARAMETER);
// Need to force level and af_family to IP(v4) when using dual stacking and provided multicast group is IPv4.
IP::Type type = _ip_type == IP::TYPE_ANY && p_ip.is_ipv4() ? IP::TYPE_IPV4 : _ip_type;
// This needs to be the proper level for the multicast group, no matter if the socket is dual stacking.
int level = type == IP::TYPE_IPV4 ? IPPROTO_IP : IPPROTO_IPV6;
int ret = -1;
IPAddress if_ip;
uint32_t if_v6id = 0;
HashMap<String, IP::Interface_Info> if_info;
IP::get_singleton()->get_local_interfaces(&if_info);
for (KeyValue<String, IP::Interface_Info> &E : if_info) {
IP::Interface_Info &c = E.value;
if (c.name != p_if_name) {
continue;
}
if_v6id = (uint32_t)c.index.to_int();
if (type == IP::TYPE_IPV6) {
break; // IPv6 uses index.
}
for (const IPAddress &F : c.ip_addresses) {
if (!F.is_ipv4()) {
continue; // Wrong IP type.
}
if_ip = F;
break;
}
break;
}
if (level == IPPROTO_IP) {
ERR_FAIL_COND_V(!if_ip.is_valid(), ERR_INVALID_PARAMETER);
struct ip_mreq greq;
int sock_opt = p_add ? IP_ADD_MEMBERSHIP : IP_DROP_MEMBERSHIP;
memcpy(&greq.imr_multiaddr, p_ip.get_ipv4(), 4);
memcpy(&greq.imr_interface, if_ip.get_ipv4(), 4);
ret = setsockopt(_sock, level, sock_opt, (const char *)&greq, sizeof(greq));
} else {
struct ipv6_mreq greq;
int sock_opt = p_add ? IPV6_ADD_MEMBERSHIP : IPV6_DROP_MEMBERSHIP;
memcpy(&greq.ipv6mr_multiaddr, p_ip.get_ipv6(), 16);
greq.ipv6mr_interface = if_v6id;
ret = setsockopt(_sock, level, sock_opt, (const char *)&greq, sizeof(greq));
}
ERR_FAIL_COND_V(ret != 0, FAILED);
return OK;
}
void NetSocketUnix::_set_socket(int p_sock, IP::Type p_ip_type, bool p_is_stream) {
_sock = p_sock;
_ip_type = p_ip_type;
_is_stream = p_is_stream;
// Disable descriptor sharing with subprocesses.
_set_close_exec_enabled(true);
}
void NetSocketUnix::_set_close_exec_enabled(bool p_enabled) {
// Enable close on exec to avoid sharing with subprocesses. Off by default on Windows.
int opts = fcntl(_sock, F_GETFD);
fcntl(_sock, F_SETFD, opts | FD_CLOEXEC);
}
Error NetSocketUnix::_inet_open(Type p_sock_type, IP::Type &r_ip_type) {
ERR_FAIL_COND_V(r_ip_type > IP::TYPE_ANY || r_ip_type < IP::TYPE_NONE, ERR_INVALID_PARAMETER);
#if defined(__OpenBSD__)
// OpenBSD does not support dual stacking, fallback to IPv4 only.
if (r_ip_type == IP::TYPE_ANY) {
r_ip_type = IP::TYPE_IPV4;
}
#endif
int family = r_ip_type == IP::TYPE_IPV4 ? AF_INET : AF_INET6;
int protocol = p_sock_type == TYPE_TCP ? IPPROTO_TCP : IPPROTO_UDP;
int type = p_sock_type == TYPE_TCP ? SOCK_STREAM : SOCK_DGRAM;
_sock = socket(family, type, protocol);
if (_sock == -1 && r_ip_type == IP::TYPE_ANY) {
// Careful here, changing the referenced parameter so the caller knows that we are using an IPv4 socket
// in place of a dual stack one, and further calls to _set_sock_addr will work as expected.
r_ip_type = IP::TYPE_IPV4;
family = AF_INET;
_sock = socket(family, type, protocol);
}
ERR_FAIL_COND_V(_sock == -1, FAILED);
_ip_type = r_ip_type;
_family = Family::INET;
if (family == AF_INET6) {
// Select IPv4 over IPv6 mapping.
set_ipv6_only_enabled(r_ip_type != IP::TYPE_ANY);
}
if (protocol == IPPROTO_UDP) {
// Make sure to disable broadcasting for UDP sockets.
// Depending on the OS, this option might or might not be enabled by default. Let's normalize it.
set_broadcasting_enabled(false);
}
_is_stream = p_sock_type == TYPE_TCP;
// Disable descriptor sharing with subprocesses.
_set_close_exec_enabled(true);
#if defined(SO_NOSIGPIPE)
// Disable SIGPIPE (should only be relevant to stream sockets, but seems to affect UDP too on iOS).
int par = 1;
if (setsockopt(_sock, SOL_SOCKET, SO_NOSIGPIPE, &par, sizeof(int)) != 0) {
print_verbose("Unable to turn off SIGPIPE on socket.");
}
#endif
return OK;
}
Error NetSocketUnix::_unix_open() {
_sock = socket(AF_UNIX, SOCK_STREAM, 0);
ERR_FAIL_COND_V(_sock == -1, FAILED);
_family = Family::UNIX;
_set_close_exec_enabled(true);
#if defined(SO_NOSIGPIPE)
// Disable SIGPIPE (should only be relevant to stream sockets, but seems to affect UDP too on iOS).
int par = 1;
if (setsockopt(_sock, SOL_SOCKET, SO_NOSIGPIPE, &par, sizeof(int)) != 0) {
print_verbose("Unable to turn off SIGPIPE on socket.");
}
#endif
return OK;
}
Error NetSocketUnix::open(NetSocket::Family p_family, NetSocket::Type p_sock_type, IP::Type &r_ip_type) {
ERR_FAIL_COND_V(is_open(), ERR_ALREADY_IN_USE);
switch (p_family) {
case Family::INET:
return _inet_open(p_sock_type, r_ip_type);
case Family::UNIX:
return _unix_open();
case Family::NONE:
default:
return ERR_INVALID_PARAMETER;
}
}
void NetSocketUnix::close() {
if (_sock != -1) {
::close(_sock);
if (_family == Family::UNIX) {
if (_unlink_on_close) {
::unlink(_unix_path.get_data());
_unlink_on_close = false;
_unix_path = CharString();
}
}
}
_sock = -1;
_family = Family::NONE;
_ip_type = IP::TYPE_NONE;
_is_stream = false;
}
Error NetSocketUnix::_inet_bind(IPAddress p_addr, uint16_t p_port) {
ERR_FAIL_COND_V(!_can_use_ip(p_addr, true), ERR_INVALID_PARAMETER);
sockaddr_storage addr;
size_t addr_size = _set_addr_storage(&addr, p_addr, p_port, _ip_type);
if (::bind(_sock, (struct sockaddr *)&addr, addr_size) != 0) {
NetError err = _get_socket_error();
print_verbose("Failed to bind socket. Error: " + itos(err) + ".");
close();
return ERR_UNAVAILABLE;
}
return OK;
}
Error NetSocketUnix::_unix_bind(const CharString &p_path) {
ERR_FAIL_COND_V(p_path.is_empty(), ERR_INVALID_PARAMETER);
struct sockaddr_un addr;
socklen_t addr_size = _unix_set_sockaddr(&addr, p_path);
ERR_FAIL_COND_V(addr_size == 0, ERR_INVALID_PARAMETER);
// If the socket file exists, attempt to remove it.
if (access(p_path.get_data(), F_OK) == 0) {
// Check if it's a socket
struct stat st;
if (stat(p_path.get_data(), &st) == 0) {
if (S_ISSOCK(st.st_mode)) {
// It is a socket, try to remove it.
if (unlink(p_path.get_data()) != 0) {
// Failed to remove existing socket file.
return FAILED;
}
} else {
// It's not a socket, don't remove it.
return ERR_ALREADY_EXISTS;
}
}
}
_unlink_on_close = true;
if (::bind(_sock, (struct sockaddr *)&addr, addr_size) != 0) {
NetError err = _get_socket_error();
print_verbose("Failed to bind socket. Error: " + itos(err) + ".");
close();
switch (err) {
case ERR_NET_UNAUTHORIZED:
return ERR_UNAUTHORIZED;
default:
return ERR_UNAVAILABLE;
}
}
return OK;
}
Error NetSocketUnix::bind(NetSocket::Address p_addr) {
ERR_FAIL_COND_V(!is_open(), ERR_UNCONFIGURED);
ERR_FAIL_COND_V(_family != p_addr.get_family(), ERR_INVALID_PARAMETER);
switch (p_addr.get_family()) {
case Family::INET: {
return _inet_bind(p_addr.ip(), p_addr.port());
}
case Family::UNIX: {
_unix_path = p_addr.get_path();
return _unix_bind(_unix_path);
}
case Family::NONE:
default:
return ERR_INVALID_PARAMETER;
}
}
Error NetSocketUnix::listen(int p_max_pending) {
ERR_FAIL_COND_V(!is_open(), ERR_UNCONFIGURED);
if (::listen(_sock, p_max_pending) != 0) {
_get_socket_error();
print_verbose("Failed to listen from socket.");
close();
return FAILED;
}
return OK;
}
Error NetSocketUnix::_inet_connect_to_host(IPAddress p_host, uint16_t p_port) {
ERR_FAIL_COND_V(!_can_use_ip(p_host, false), ERR_INVALID_PARAMETER);
struct sockaddr_storage addr;
size_t addr_size = _set_addr_storage(&addr, p_host, p_port, _ip_type);
if (::connect(_sock, (struct sockaddr *)&addr, addr_size) != 0) {
NetError err = _get_socket_error();
switch (err) {
// We are already connected.
case ERR_NET_IS_CONNECTED:
return OK;
// Still waiting to connect, try again in a while.
case ERR_NET_WOULD_BLOCK:
case ERR_NET_IN_PROGRESS:
return ERR_BUSY;
default:
print_verbose("Connection to remote host failed.");
close();
return FAILED;
}
}
return OK;
}
Error NetSocketUnix::_unix_connect_to_host(const CharString &p_path) {
ERR_FAIL_COND_V(!_can_use_path(p_path), ERR_INVALID_PARAMETER);
struct sockaddr_un addr;
socklen_t addr_size = _unix_set_sockaddr(&addr, p_path);
ERR_FAIL_COND_V(addr_size == 0, ERR_INVALID_PARAMETER);
if (::connect(_sock, (struct sockaddr *)&addr, addr_size) != 0) {
NetError err = _get_socket_error();
switch (err) {
case ERR_NET_ADDRESS_INVALID_OR_UNAVAILABLE:
return ERR_INVALID_PARAMETER;
// Still waiting to connect, try again in a while.
case ERR_NET_WOULD_BLOCK:
case ERR_NET_IN_PROGRESS:
return ERR_BUSY;
case ERR_NET_UNAUTHORIZED:
return ERR_UNAUTHORIZED;
default:
print_verbose("Connection to host failed.");
close();
return FAILED;
}
}
return OK;
}
Error NetSocketUnix::connect_to_host(NetSocket::Address p_addr) {
ERR_FAIL_COND_V(!is_open(), ERR_UNCONFIGURED);
ERR_FAIL_COND_V(_family != p_addr.get_family(), ERR_INVALID_PARAMETER);
switch (p_addr.get_family()) {
case Family::INET:
return _inet_connect_to_host(p_addr.ip(), p_addr.port());
case Family::UNIX:
return _unix_connect_to_host(p_addr.get_path());
case Family::NONE:
default:
return ERR_INVALID_PARAMETER;
}
}
Error NetSocketUnix::poll(PollType p_type, int p_timeout) const {
ERR_FAIL_COND_V(!is_open(), ERR_UNCONFIGURED);
struct pollfd pfd;
pfd.fd = _sock;
pfd.events = POLLIN;
pfd.revents = 0;
switch (p_type) {
case POLL_TYPE_IN:
pfd.events = POLLIN;
break;
case POLL_TYPE_OUT:
pfd.events = POLLOUT;
break;
case POLL_TYPE_IN_OUT:
pfd.events = POLLOUT | POLLIN;
}
int ret = ::poll(&pfd, 1, p_timeout);
if (ret < 0 || pfd.revents & POLLERR) {
_get_socket_error();
print_verbose("Error when polling socket.");
return FAILED;
}
if (ret == 0) {
return ERR_BUSY;
}
return OK;
}
Error NetSocketUnix::recv(uint8_t *p_buffer, int p_len, int &r_read) {
ERR_FAIL_COND_V(!is_open(), ERR_UNCONFIGURED);
r_read = ::recv(_sock, p_buffer, p_len, 0);
if (r_read < 0) {
NetError err = _get_socket_error();
if (err == ERR_NET_WOULD_BLOCK) {
return ERR_BUSY;
}
if (err == ERR_NET_BUFFER_TOO_SMALL) {
return ERR_OUT_OF_MEMORY;
}
return FAILED;
}
return OK;
}
Error NetSocketUnix::recvfrom(uint8_t *p_buffer, int p_len, int &r_read, IPAddress &r_ip, uint16_t &r_port, bool p_peek) {
ERR_FAIL_COND_V(!is_open(), ERR_UNCONFIGURED);
ERR_FAIL_COND_V(_family != Family::INET, ERR_UNAVAILABLE);
struct sockaddr_storage from;
socklen_t len = sizeof(struct sockaddr_storage);
memset(&from, 0, len);
r_read = ::recvfrom(_sock, p_buffer, p_len, p_peek ? MSG_PEEK : 0, (struct sockaddr *)&from, &len);
if (r_read < 0) {
NetError err = _get_socket_error();
if (err == ERR_NET_WOULD_BLOCK) {
return ERR_BUSY;
}
if (err == ERR_NET_BUFFER_TOO_SMALL) {
return ERR_OUT_OF_MEMORY;
}
return FAILED;
}
if (from.ss_family == AF_INET) {
struct sockaddr_in *sin_from = (struct sockaddr_in *)&from;
r_ip.set_ipv4((uint8_t *)&sin_from->sin_addr);
r_port = ntohs(sin_from->sin_port);
} else if (from.ss_family == AF_INET6) {
struct sockaddr_in6 *s6_from = (struct sockaddr_in6 *)&from;
r_ip.set_ipv6((uint8_t *)&s6_from->sin6_addr);
r_port = ntohs(s6_from->sin6_port);
} else {
// Unsupported socket family, should never happen.
ERR_FAIL_V(FAILED);
}
return OK;
}
Error NetSocketUnix::send(const uint8_t *p_buffer, int p_len, int &r_sent) {
ERR_FAIL_COND_V(!is_open(), ERR_UNCONFIGURED);
int flags = 0;
#ifdef MSG_NOSIGNAL
if (_is_stream || _family == Family::UNIX) {
flags = MSG_NOSIGNAL;
}
#endif
r_sent = ::send(_sock, p_buffer, p_len, flags);
if (r_sent < 0) {
NetError err = _get_socket_error();
if (err == ERR_NET_WOULD_BLOCK) {
return ERR_BUSY;
}
if (err == ERR_NET_BUFFER_TOO_SMALL) {
return ERR_OUT_OF_MEMORY;
}
return FAILED;
}
return OK;
}
Error NetSocketUnix::sendto(const uint8_t *p_buffer, int p_len, int &r_sent, IPAddress p_ip, uint16_t p_port) {
ERR_FAIL_COND_V(!is_open(), ERR_UNCONFIGURED);
ERR_FAIL_COND_V(_family != Family::INET, ERR_UNAVAILABLE);
struct sockaddr_storage addr;
size_t addr_size = _set_addr_storage(&addr, p_ip, p_port, _ip_type);
r_sent = ::sendto(_sock, p_buffer, p_len, 0, (struct sockaddr *)&addr, addr_size);
if (r_sent < 0) {
NetError err = _get_socket_error();
if (err == ERR_NET_WOULD_BLOCK) {
return ERR_BUSY;
}
if (err == ERR_NET_BUFFER_TOO_SMALL) {
return ERR_OUT_OF_MEMORY;
}
return FAILED;
}
return OK;
}
Error NetSocketUnix::set_broadcasting_enabled(bool p_enabled) {
ERR_FAIL_COND_V(!is_open(), ERR_UNCONFIGURED);
// IPv6 has no broadcast support.
if (_ip_type == IP::TYPE_IPV6) {
return ERR_UNAVAILABLE;
}
int par = p_enabled ? 1 : 0;
if (setsockopt(_sock, SOL_SOCKET, SO_BROADCAST, &par, sizeof(int)) != 0) {
WARN_PRINT("Unable to change broadcast setting.");
return FAILED;
}
return OK;
}
void NetSocketUnix::set_blocking_enabled(bool p_enabled) {
ERR_FAIL_COND(!is_open());
int ret = 0;
int opts = fcntl(_sock, F_GETFL);
if (p_enabled) {
ret = fcntl(_sock, F_SETFL, opts & ~O_NONBLOCK);
} else {
ret = fcntl(_sock, F_SETFL, opts | O_NONBLOCK);
}
if (ret != 0) {
WARN_PRINT("Unable to change non-block mode.");
}
}
void NetSocketUnix::set_ipv6_only_enabled(bool p_enabled) {
ERR_FAIL_COND(!is_open());
// This option is only available in IPv6 sockets.
ERR_FAIL_COND(_ip_type == IP::TYPE_IPV4);
int par = p_enabled ? 1 : 0;
if (setsockopt(_sock, IPPROTO_IPV6, IPV6_V6ONLY, &par, sizeof(int)) != 0) {
WARN_PRINT("Unable to change IPv4 address mapping over IPv6 option.");
}
}
void NetSocketUnix::set_tcp_no_delay_enabled(bool p_enabled) {
ERR_FAIL_COND(!is_open());
ERR_FAIL_COND(!_is_stream); // Not TCP.
int par = p_enabled ? 1 : 0;
if (setsockopt(_sock, IPPROTO_TCP, TCP_NODELAY, &par, sizeof(int)) < 0) {
WARN_PRINT("Unable to set TCP no delay option.");
}
}
void NetSocketUnix::set_reuse_address_enabled(bool p_enabled) {
ERR_FAIL_COND(!is_open());
int par = p_enabled ? 1 : 0;
if (setsockopt(_sock, SOL_SOCKET, SO_REUSEADDR, &par, sizeof(int)) < 0) {
WARN_PRINT("Unable to set socket REUSEADDR option.");
}
}
bool NetSocketUnix::is_open() const {
return _sock != -1;
}
int NetSocketUnix::get_available_bytes() const {
ERR_FAIL_COND_V(!is_open(), -1);
int len;
int ret = ioctl(_sock, FIONREAD, &len);
if (ret == -1) {
_get_socket_error();
print_verbose("Error when checking available bytes on socket.");
return -1;
}
return len;
}
Error NetSocketUnix::_inet_get_socket_address(IPAddress *r_ip, uint16_t *r_port) const {
struct sockaddr_storage saddr;
socklen_t len = sizeof(saddr);
if (getsockname(_sock, (struct sockaddr *)&saddr, &len) != 0) {
_get_socket_error();
print_verbose("Error when reading local socket address.");
return FAILED;
}
_set_ip_port(&saddr, r_ip, r_port);
return OK;
}
Error NetSocketUnix::get_socket_address(NetSocket::Address *r_addr) const {
ERR_FAIL_COND_V(!is_open(), FAILED);
switch (_family) {
case Family::INET: {
IPAddress ip;
uint16_t port = 0;
Error res = _inet_get_socket_address(&ip, &port);
ERR_FAIL_COND_V(res != OK, res);
if (r_addr) {
Address addr(ip, port);
*r_addr = addr;
}
} break;
case Family::UNIX: {
if (r_addr) {
*r_addr = Address(_unix_path);
}
} break;
case Family::NONE:
default:
return FAILED;
}
return OK;
}
Ref<NetSocket> NetSocketUnix::_inet_accept(IPAddress &r_ip, uint16_t &r_port) {
struct sockaddr_storage their_addr;
socklen_t size = sizeof(their_addr);
int fd = ::accept(_sock, (struct sockaddr *)&their_addr, &size);
if (fd == -1) {
_get_socket_error();
print_verbose("Error when accepting socket connection.");
return Ref<NetSocket>();
}
_set_ip_port(&their_addr, &r_ip, &r_port);
Ref<NetSocketUnix> ns;
ns.instantiate();
ns->_set_socket(fd, _ip_type, _is_stream);
ns->set_blocking_enabled(false);
return Ref<NetSocket>(ns);
}
Ref<NetSocket> NetSocketUnix::_unix_accept() {
struct sockaddr_un addr;
socklen_t addr_len = sizeof(addr);
int fd = ::accept(_sock, (struct sockaddr *)&addr, &addr_len);
if (fd == -1) {
_get_socket_error();
print_verbose("Error when accepting socket connection.");
return Ref<NetSocket>();
}
Ref<NetSocketUnix> ret = memnew(NetSocketUnix);
ret->_sock = fd;
ret->_family = _family;
ret->_unix_path = _unix_path;
ret->set_blocking_enabled(false);
return Ref<NetSocket>(ret);
}
Ref<NetSocket> NetSocketUnix::accept(NetSocket::Address &r_addr) {
Ref<NetSocket> out;
ERR_FAIL_COND_V(!is_open(), out);
switch (_family) {
case Family::INET: {
IPAddress ip;
uint16_t port;
out = _inet_accept(ip, port);
if (out.is_valid()) {
r_addr = Address(ip, port);
}
} break;
case Family::UNIX: {
out = _unix_accept();
} break;
case Family::NONE:
default:
break;
}
return out;
}
Error NetSocketUnix::join_multicast_group(const IPAddress &p_multi_address, const String &p_if_name) {
return _change_multicast_group(p_multi_address, p_if_name, true);
}
Error NetSocketUnix::leave_multicast_group(const IPAddress &p_multi_address, const String &p_if_name) {
return _change_multicast_group(p_multi_address, p_if_name, false);
}
#endif // UNIX_ENABLED && !UNIX_SOCKET_UNAVAILABLE