socket_utils.h

Go to the documentation of this file.

 
/* Copyright (C) 2006-2023 Olly Betts
 * Copyright (C) 2008 Lemur Consulting Ltd
 *
 * This program 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; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program; if not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#ifndef XAPIAN_INCLUDED_SOCKET_UTILS_H
#define XAPIAN_INCLUDED_SOCKET_UTILS_H
 
#include "safenetdb.h"
#include "safeunistd.h"
 
#include <cerrno>
 
#ifdef __WIN32__
 
# include "safewinsock2.h"
 
# include <xapian/error.h>
 
extern HANDLE fd_to_handle(int fd);
 
extern void close_fd_or_socket(int fd);
 
struct WinsockInitializer {
    WinsockInitializer() {
        WSADATA wsadata;
        int wsaerror = WSAStartup(MAKEWORD(2, 2), &wsadata);
        // FIXME - should we check the returned information in wsadata to check
        // that we have a version of winsock which is recent enough for us?
 
        if (wsaerror != 0) {
            throw Xapian::NetworkError("Failed to initialize winsock", wsaerror);
        }
    }
 
    ~WinsockInitializer() {
        WSACleanup();
    }
};
 
inline int socket_errno() {
    int wsa_err = WSAGetLastError();
    switch (wsa_err) {
# ifdef EADDRINUSE
        case WSAEADDRINUSE: return EADDRINUSE;
# endif
# ifdef ETIMEDOUT
        case WSAETIMEDOUT: return ETIMEDOUT;
# endif
# ifdef EINPROGRESS
        case WSAEINPROGRESS: return EINPROGRESS;
# endif
        default: return wsa_err;
    }
}
 
/* Newer compilers define these, in which case we map to those already defined
 * values in socket_errno() above.
 */
# ifndef EADDRINUSE
#  define EADDRINUSE WSAEADDRINUSE
# endif
# ifndef ETIMEDOUT
#  define ETIMEDOUT WSAETIMEDOUT
# endif
# ifndef EINPROGRESS
#  define EINPROGRESS WSAEINPROGRESS
# endif
 
// We must call closesocket() (instead of just close()) under __WIN32__ or
// else the socket remains in the CLOSE_WAIT state.
# define CLOSESOCKET(S) closesocket(S)
 
#else
 
// For INET_ADDRSTRLEN and INET6_ADDRSTRLEN.
#include <arpa/inet.h>
 
// There's no distinction between sockets and other fds on UNIX.
inline void close_fd_or_socket(int fd) { close(fd); }
 
inline int socket_errno() { return errno; }
 
# define CLOSESOCKET(S) close(S)
 
#endif
 
void set_socket_timeouts(int fd, double timeout);
 
constexpr size_t PRETTY_IP6_LEN =
    (INET6_ADDRSTRLEN > INET_ADDRSTRLEN ? INET6_ADDRSTRLEN : INET_ADDRSTRLEN);
 
int pretty_ip6(const void* p, char* buf);
 
#endif // XAPIAN_INCLUDED_SOCKET_UTILS_H