* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id$
- *
+ */
+/** @file
+ * @brief Implementation of OS-dependent operations.
+ * @version $Id$
*/
#include "config.h"
-#define _XOPEN_SOURCE 500 /* make limits.h #define IOV_MAX */
-#define __EXTENSIONS__ 1 /* make Solaris netinet/in.h know IPv6 */
+#ifdef IRCU_SOLARIS
+/* Solaris requires C99 support for SUSv3, but C99 support breaks other
+ * parts of the build. So fall back to SUSv2, but request IPv6 support
+ * by defining __EXTENSIONS__.
+ */
+#define _XOPEN_SOURCE 500
+#define __EXTENSIONS__ 1
+#elif defined(__FreeBSD__) && __FreeBSD__ >= 5
+/* FreeBSD 6.0 requires SUSv3 to support IPv6 -- but if you ask for
+ * that specifically (by defining _XOPEN_SOURCE to anything at all),
+ * they cleverly hide IPPROTO_IPV6. If you don't ask for anything,
+ * they give you everything.
+ */
+#else
+#define _XOPEN_SOURCE 600
+#endif
#include "ircd_osdep.h"
#include "msgq.h"
+#include "ircd_log.h"
#include "res.h"
#include "s_bsd.h"
#include "sys.h"
* Solaris requires sys/time.h before struct rusage (indirectly) in
* netinet/in.h.
*/
-#include <assert.h>
+/* #include <assert.h> -- Now using assert in ircd_log.h */
#include <errno.h>
#include <fcntl.h>
#include <limits.h>
#include <unistd.h>
#endif
+#if defined(IPV6_BINDV6ONLY) &&!defined(IPV6_V6ONLY)
+# define IPV6_V6ONLY IPV6_BINDV6ONLY
+#endif
+
#ifndef IOV_MAX
-#define IOV_MAX 16 /* minimum required */
+#define IOV_MAX 16 /**< minimum required length of an iovec array */
#endif
#ifdef HPUX
#define getrusage(a,b) syscall(SYS_GETRUSAGE, a, b)
#endif
+static int is_blocked(int error)
+{
+ return EWOULDBLOCK == error
+#ifdef ENOMEM
+ || ENOMEM == error
+#endif
+#ifdef ENOBUFS
+ || ENOBUFS == error
+#endif
+ || EAGAIN == error;
+}
+
+static void sockaddr_in_to_irc(const struct sockaddr_in *v4,
+ struct irc_sockaddr *irc)
+{
+ memset(&irc->addr, 0, 5*sizeof(int16_t));
+ irc->addr.in6_16[5] = 0xffff;
+ memcpy(&irc->addr.in6_16[6], &v4->sin_addr, sizeof(v4->sin_addr));
+ irc->port = ntohs(v4->sin_port);
+}
+
+
#ifdef IPV6
+/** Native socket address type. */
#define sockaddr_native sockaddr_in6
+/** Field name inside sockaddr_native to find address family. */
#define sn_family sin6_family
+/** Convert native socket address to IRC format.
+ * @param[in] v6 Native socket address.
+ * @param[out] irc IRC format socket address.
+ */
void sockaddr_to_irc(const struct sockaddr_in6 *v6, struct irc_sockaddr *irc)
{
if (v6->sin6_family == AF_INET6) {
irc->port = ntohs(v6->sin6_port);
}
else if (v6->sin6_family == AF_INET) {
- const struct sockaddr_in *v4 = (const struct sockaddr_in*)v6;
- memset(&irc->addr, 0, 5*sizeof(int16_t));
- irc->addr.in6_16[5] = 0xffff;
- memcpy(&irc->addr.in6_16[6], &v4->sin_addr, sizeof(v4->sin_addr));
- irc->port = ntohs(v4->sin_port);
+ sockaddr_in_to_irc((struct sockaddr_in *)v6, irc);
}
else assert(0 && "Unhandled native address family");
}
-int sockaddr_from_irc(struct sockaddr_in6 *v6, const struct irc_sockaddr *irc, int persist)
+/** Convert IRC socket address to native format.
+ * @param[out] v6 Native socket address.
+ * @param[in] irc IRC socket address.
+ * @param[in] compat_fd If non-negative, an FD specifying address family.
+ * @return Length of address written to \a v6.
+ */
+int sockaddr_from_irc(struct sockaddr_in6 *v6, const struct irc_sockaddr *irc, int compat_fd, int family)
{
+ struct sockaddr_in6 sin6;
+ socklen_t slen;
+
+ assert(irc != 0);
+ slen = sizeof(sin6);
+ if (family) {
+ /* accept whatever user specified */
+ } else if ((0 <= compat_fd)
+ && (0 == getsockname(compat_fd, (struct sockaddr*)&sin6, &slen)))
+ family = sin6.sin6_family;
+ else if ((irc == &VirtualHost_v4) || irc_in_addr_is_ipv4(&irc->addr))
+ family = AF_INET;
+ else
+ family = AF_INET6;
+
memset(v6, 0, sizeof(*v6));
- if (!irc) {
- memset(v6, 0, sizeof(v6));
- v6->sin6_family = AF_INET6;
- return sizeof(*v6);
- }
- else if (persist && irc_in_addr_is_ipv4(&irc->addr)) {
+ if (family == AF_INET) {
struct sockaddr_in *v4 = (struct sockaddr_in*)v6;
v4->sin_family = AF_INET;
memcpy(&v4->sin_addr, &irc->addr.in6_16[6], sizeof(v4->sin_addr));
#else
#define sockaddr_native sockaddr_in
#define sn_family sin_family
+#define sockaddr_to_irc sockaddr_in_to_irc
-void sockaddr_to_irc(const struct sockaddr_in *v4, struct irc_sockaddr *irc)
-{
- assert(v4->sin_family == AF_INET);
- memset(&irc->addr, 0, 6*sizeof(irc->addr.in6_16[0]));
- memcpy(&irc->addr.in6_16[6], &v4->sin_addr, sizeof(v4->sin_addr));
- irc->port = ntohs(v4->sin_port);
-}
-
-int sockaddr_from_irc(struct sockaddr_in *v4, const struct irc_sockaddr *irc, int persist)
+int sockaddr_from_irc(struct sockaddr_in *v4, const struct irc_sockaddr *irc, int compat_fd, int family)
{
+ assert(irc != 0);
+ memset(v4, 0, sizeof(*v4));
v4->sin_family = AF_INET;
if (irc) {
assert(!irc->addr.in6_16[0] && !irc->addr.in6_16[1] && !irc->addr.in6_16[2] && !irc->addr.in6_16[3] && !irc->addr.in6_16[4] && (!irc->addr.in6_16[5] || irc->addr.in6_16[5] == 0xffff));
memcpy(&v4->sin_addr, &irc->addr.in6_16[6], sizeof(v4->sin_addr));
v4->sin_port = htons(irc->port);
- } else{
- memset(&v4, 0, sizeof(v4));
}
- (void)persist;
+ (void)compat_fd; (void)family;
return sizeof(*v4);
}
#endif
-/*
- * This is part of the STATS replies. There is no offical numeric for this
- * since this isnt an official command, in much the same way as HASH isnt.
- * It is also possible that some systems wont support this call or have
- * different field names for "struct rusage".
- * -avalon
+#ifdef DEBUGMODE
+/** Send resource usage information to an enumerator function.
+ * @param[in] cptr Client requesting information.
+ * @param[in] uptime Wall time in seconds since the server started.
+ * @param[in] enumerator Function to call to send a line to \a cptr.
+ * @return Zero if some usage reports could not be sent, non-zero on success.
*/
int os_get_rusage(struct Client *cptr, int uptime, EnumFn enumerator)
{
#endif /* HAVE_GETRUSAGE */
return 1;
}
+#endif
+/** Look up the most recent socket error for a socket file descriptor.
+ * @param[in] fd File descriptor to check.
+ * @return Error code from the socket, or 0 if the OS does not support this.
+ */
int os_get_sockerr(int fd)
{
int err = 0;
return err;
}
-/*
- * set_non_blocking
- *
- * Set the client connection into non-blocking mode. If your
- * system doesn't support this, you can make this a dummy
- * function (and get all the old problems that plagued the
- * blocking version of IRC--not a problem if you are a
- * lightly loaded node...)
+/** Set a file descriptor to non-blocking mode.
+ * @param[in] fd %Socket file descriptor.
+ * @return Non-zero on success, or zero on failure.
*/
int os_set_nonblocking(int fd)
{
return 1;
}
-
-/*
- * set_sock_opts
+/** Mark a socket's address as reusable.
+ * @param[in] fd %Socket file descriptor to manipulate.
+ * @return Non-zero on success, or zero on failure.
*/
int os_set_reuseaddr(int fd)
{
(const char*) &opt, sizeof(opt)));
}
+/** Set a socket's send and receive buffer sizes.
+ * @param[in] fd %Socket file descriptor to manipulate.
+ * @param[in] ssize New send buffer size.
+ * @param[in] rsize New receive buffer size.
+ * @return Non-zero on success, or zero on failure.
+ */
int os_set_sockbufs(int fd, unsigned int ssize, unsigned int rsize)
{
unsigned int sopt = ssize;
(const char*) &sopt, sizeof(sopt)));
}
+/** Set a socket's "type of service" value.
+ * @param[in] fd %Socket file descriptor to manipulate.
+ * @param[in] tos New type of service value to use.
+ * @return Non-zero on success, or zero on failure.
+ */
int os_set_tos(int fd,int tos)
{
#if defined(IP_TOS) && defined(IPPROTO_IP)
#endif
}
+/** Disable IP options on a socket.
+ * @param[in] fd %Socket file descriptor to manipulate.
+ * @return Non-zero on success, or zero on failure.
+ */
int os_disable_options(int fd)
{
#if defined(IP_OPTIONS) && defined(IPPROTO_IP)
#endif
#endif
+/** Set file descriptor limit for the process.
+ * @param[in] max_descriptors Ideal number of file descriptors.
+ * @return Zero on success; -1 on error; positive number of possible
+ * file descriptors if \a max_descriptors is too high.
+ */
int os_set_fdlimit(unsigned int max_descriptors)
{
#if defined(HAVE_SETRLIMIT) && defined(RLIMIT_FD_MAX)
struct rlimit limit;
if (!getrlimit(RLIMIT_FD_MAX, &limit)) {
- if (limit.rlim_max < MAXCONNECTIONS)
+ if (limit.rlim_max < max_descriptors)
return limit.rlim_max;
limit.rlim_cur = limit.rlim_max; /* make soft limit the max */
return setrlimit(RLIMIT_FD_MAX, &limit);
return 0;
}
-/*
- * os_recv_nonb - non blocking read of a connection
- * returns:
- * 1 if data was read or socket is blocked (recoverable error)
- * count_out > 0 if data was read
- *
- * 0 if socket closed from other end
- * -1 if an unrecoverable error occurred
+/** Attempt to read from a non-blocking socket.
+ * @param[in] fd File descriptor to read from.
+ * @param[out] buf Output buffer to read into.
+ * @param[in] length Number of bytes to read.
+ * @param[out] count_out Receives number of bytes actually read.
+ * @return An IOResult value indicating status.
*/
IOResult os_recv_nonb(int fd, char* buf, unsigned int length,
unsigned int* count_out)
int res;
assert(0 != buf);
assert(0 != count_out);
- *count_out = 0;
- errno = 0;
if (0 < (res = recv(fd, buf, length, 0))) {
*count_out = (unsigned) res;
return IO_SUCCESS;
+ } else if (res == 0) {
+ *count_out = 0;
+ errno = 0; /* or ECONNRESET? */
+ return IO_FAILURE;
+ } else {
+ *count_out = 0;
+ return is_blocked(errno) ? IO_BLOCKED : IO_FAILURE;
}
- else if (res < 0) {
- if (EWOULDBLOCK == errno || EAGAIN == errno
-#ifdef ENOMEM
- || ENOMEM == errno
-#endif
-#ifdef ENOBUFS
- || ENOBUFS == errno
-#endif
- )
- return IO_BLOCKED;
- else
- return IO_FAILURE;
- }
- /*
- * 0 == client closed the connection
- * < 1 == error
- */
- return IO_FAILURE;
}
+/** Attempt to read from a non-blocking UDP socket.
+ * @param[in] fd File descriptor to read from.
+ * @param[out] buf Output buffer to read into.
+ * @param[in] length Number of bytes to read.
+ * @param[out] length_out Receives number of bytes actually read.
+ * @param[out] addr_out Peer address that sent the message.
+ * @return An IOResult value indicating status.
+ */
IOResult os_recvfrom_nonb(int fd, char* buf, unsigned int length,
unsigned int* length_out,
struct irc_sockaddr* addr_out)
assert(0 != buf);
assert(0 != length_out);
assert(0 != addr_out);
- errno = 0;
- *length_out = 0;
res = recvfrom(fd, buf, length, 0, (struct sockaddr*) &addr, &len);
- if (-1 == res) {
- if (EWOULDBLOCK == errno || ENOMEM == errno
-#ifdef ENOMEM
- || ENOMEM == errno
-#endif
-#ifdef ENOBUFS
- || ENOBUFS == errno
-#endif
- )
- return IO_BLOCKED;
- return IO_FAILURE;
+ if (-1 < res) {
+ sockaddr_to_irc(&addr, addr_out);
+ *length_out = res;
+ return IO_SUCCESS;
+ } else {
+ *length_out = 0;
+ return is_blocked(errno) ? IO_BLOCKED : IO_FAILURE;
}
- sockaddr_to_irc(&addr, addr_out);
- *length_out = res;
- return IO_SUCCESS;
}
-/*
- * os_sendto_nonb - non blocking send to a UDP socket
- * returns:
- * 1 if data was written, *count_out contains number of bytes
- * 0 if sendto call blocked
- * -1 if an unrecoverable error occurred
+/** Attempt to write on a non-blocking UDP socket.
+ * @param[in] fd File descriptor to write to.
+ * @param[in] buf Output buffer to send from.
+ * @param[in] length Number of bytes to write.
+ * @param[out] count_out Receives number of bytes actually written.
+ * @param[in] flags Flags for call to sendto().
+ * @param[in] peer Destination address of the message.
+ * @return An IOResult value indicating status.
*/
IOResult os_sendto_nonb(int fd, const char* buf, unsigned int length,
unsigned int* count_out, unsigned int flags,
struct sockaddr_native addr;
int res, size;
assert(0 != buf);
- if (count_out)
- *count_out = 0;
- errno = 0;
- size = sockaddr_from_irc(&addr, peer, 1);
+ size = sockaddr_from_irc(&addr, peer, fd, 0);
+ assert((addr.sn_family == AF_INET) == irc_in_addr_is_ipv4(&peer->addr));
if (-1 < (res = sendto(fd, buf, length, flags, (struct sockaddr*)&addr, size))) {
if (count_out)
*count_out = (unsigned) res;
return IO_SUCCESS;
+ } else {
+ if (count_out)
+ *count_out = 0;
+ return is_blocked(errno) ? IO_BLOCKED : IO_FAILURE;
}
- else if (EWOULDBLOCK == errno || EAGAIN == errno
-#ifdef ENOMEM
- || ENOMEM == errno
-#endif
-#ifdef ENOBUFS
- || ENOBUFS == errno
-#endif
- )
- return IO_BLOCKED;
- return IO_FAILURE;
}
-/*
- * os_send_nonb - non blocking read of a connection
- * returns:
- * 1 if data was written
- * count_out contains amount written
- *
- * 0 if write call blocked, recoverable error
- * -1 if an unrecoverable error occurred
+/** Attempt to write on a connected socket.
+ * @param[in] fd File descriptor to write to.
+ * @param[in] buf Output buffer to send from.
+ * @param[in] length Number of bytes to write.
+ * @param[out] count_out Receives number of bytes actually written.
+ * @return An IOResult value indicating status.
*/
IOResult os_send_nonb(int fd, const char* buf, unsigned int length,
unsigned int* count_out)
int res;
assert(0 != buf);
assert(0 != count_out);
- *count_out = 0;
- errno = 0;
if (-1 < (res = send(fd, buf, length, 0))) {
*count_out = (unsigned) res;
return IO_SUCCESS;
+ } else {
+ *count_out = 0;
+ return is_blocked(errno) ? IO_BLOCKED : IO_FAILURE;
}
- else if (EWOULDBLOCK == errno || EAGAIN == errno
-#ifdef ENOMEM
- || ENOMEM == errno
-#endif
-#ifdef ENOBUFS
- || ENOBUFS == errno
-#endif
- )
- return IO_BLOCKED;
- return IO_FAILURE;
}
+/** Attempt a vectored write on a connected socket.
+ * @param[in] fd File descriptor to write to.
+ * @param[in] buf Message queue to send from.
+ * @param[out] count_in Number of bytes mapped from \a buf.
+ * @param[out] count_out Receives number of bytes actually written.
+ * @return An IOResult value indicating status.
+ */
IOResult os_sendv_nonb(int fd, struct MsgQ* buf, unsigned int* count_in,
unsigned int* count_out)
{
assert(0 != count_out);
*count_in = 0;
- *count_out = 0;
- errno = 0;
-
count = msgq_mapiov(buf, iov, IOV_MAX, count_in);
if (-1 < (res = writev(fd, iov, count))) {
*count_out = (unsigned) res;
return IO_SUCCESS;
+ } else {
+ *count_out = 0;
+ return is_blocked(errno) ? IO_BLOCKED : IO_FAILURE;
}
- else if (EWOULDBLOCK == errno || EAGAIN == errno
-#ifdef ENOMEM
- || ENOMEM == errno
-#endif
-#ifdef ENOBUFS
- || ENOBUFS == errno
-#endif
- )
- return IO_BLOCKED;
-
- return IO_FAILURE;
}
-int os_socket(const struct irc_sockaddr* local, int type, const char* port_name)
+/** Open a TCP or UDP socket on a particular address.
+ * @param[in] local Local address to bind to.
+ * @param[in] type SOCK_STREAM or SOCK_DGRAM.
+ * @param[in] port_name Port name (used in error diagnostics).
+ * @param[in] family A specific address family to use, or 0 for automatic.
+ * @return Bound descriptor, or -1 on error.
+ */
+int os_socket(const struct irc_sockaddr* local, int type, const char* port_name, int family)
{
struct sockaddr_native addr;
int size, fd;
- size = sockaddr_from_irc(&addr, local, 1);
+ assert(local != 0);
+ size = sockaddr_from_irc(&addr, local, -1, family);
fd = socket(addr.sn_family, type, 0);
if (fd < 0) {
report_error(SOCKET_ERROR_MSG, port_name, errno);
return -1;
}
if (local) {
+#if defined(IPV6_V6ONLY)
+ int on = 1;
+ if (family == AF_INET6 && irc_in_addr_unspec(&local->addr))
+ setsockopt(fd, IPPROTO_IPV6, IPV6_V6ONLY, &on, sizeof(on));
+#endif
if (bind(fd, (struct sockaddr*)&addr, size)) {
report_error(BIND_ERROR_MSG, port_name, errno);
close(fd);
return fd;
}
+/** Accept a connection on a socket.
+ * @param[in] fd Listening file descriptor.
+ * @param[out] peer Peer address of connection.
+ * @return File descriptor for accepted connection.
+ */
int os_accept(int fd, struct irc_sockaddr* peer)
{
struct sockaddr_native addr;
return new_fd;
}
+/** Start a non-blocking connection.
+ * @param[in] fd Disconnected file descriptor.
+ * @param[in] sin Target address for connection.
+ * @return IOResult code indicating status.
+ */
IOResult os_connect_nonb(int fd, const struct irc_sockaddr* sin)
{
struct sockaddr_native addr;
int size;
- size = sockaddr_from_irc(&addr, sin, 1);
- if (connect(fd, (struct sockaddr*) &addr, size))
- return (errno == EINPROGRESS) ? IO_BLOCKED : IO_FAILURE;
- return IO_SUCCESS;
+ size = sockaddr_from_irc(&addr, sin, fd, 0);
+ if (0 == connect(fd, (struct sockaddr*) &addr, size))
+ return IO_SUCCESS;
+ else if (errno == EINPROGRESS)
+ return IO_BLOCKED;
+ else
+ return IO_FAILURE;
}
+/** Get local address of a socket.
+ * @param[in] fd File descriptor to operate on.
+ * @param[out] sin_out Receives local socket address.
+ * @return Non-zero on success; zero on error.
+ */
int os_get_sockname(int fd, struct irc_sockaddr* sin_out)
{
struct sockaddr_native addr;
return 1;
}
+/** Get remote address of a socket.
+ * @param[in] fd File descriptor to operate on.
+ * @param[out] sin_out Receives remote socket address.
+ * @return Non-zero on success; zero on error.
+ */
int os_get_peername(int fd, struct irc_sockaddr* sin_out)
{
struct sockaddr_native addr;
return 1;
}
+/** Start listening on a socket.
+ * @param[in] fd Disconnected file descriptor.
+ * @param[in] backlog Maximum number of un-accept()ed connections to keep.
+ * @return Non-zero on success; zero on error.
+ */
int os_set_listen(int fd, int backlog)
{
return (0 == listen(fd, backlog));
}
+
+/** Allocate a connected pair of local sockets.
+ * @param[out] sv Array of two file descriptors.
+ * @return Zero on success; non-zero number on error.
+ */
+int os_socketpair(int sv[2])
+{
+ return socketpair(AF_UNIX, SOCK_STREAM, 0, sv);
+}
projects / ircu2.10.12-pk.git / blobdiff