net/tcpserver.cc

Go to the documentation of this file.

/* tcpserver.cc: class for TCP/IP-based server.
 *
 * Copyright 1999,2000,2001 BrightStation PLC
 * Copyright 2002 Ananova Ltd
 * Copyright 2002,2003,2004,2005,2006,2007,2008,2009,2010,2011 Olly Betts
 *
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
 * USA
 */

#include <config.h>

#include "tcpserver.h"

#include <xapian/error.h>

#include "safeerrno.h"
#include "safefcntl.h"

#include "noreturn.h"
#include "remoteconnection.h"
#include "utils.h"

#ifdef __WIN32__
# include <process.h>    /* _beginthread, _endthread */
#else
# include <sys/socket.h>
# include <netinet/in_systm.h>
# include <netinet/in.h>
# include <netinet/ip.h>
# include <netinet/tcp.h>
# include <arpa/inet.h>
# include <netdb.h>
# include <signal.h>
# include <sys/wait.h>
#endif

#include <iostream>

#include <cstring>
#include <cstdio> // For sprintf() on __WIN32__ or cygwin.
#include <sys/types.h>

using namespace std;

// Handle older systems.
#if !defined SIGCHLD && defined SIGCLD
# define SIGCHLD SIGCLD
#endif

#ifdef __WIN32__
// 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
# define CLOSESOCKET(S) close(S)
#endif

TcpServer::TcpServer(const std::string & host, int port, bool tcp_nodelay,
                     bool verbose_)
    :
#if defined __CYGWIN__ || defined __WIN32__
      mutex(NULL),
#endif
      listen_socket(get_listening_socket(host, port, tcp_nodelay
#if defined __CYGWIN__ || defined __WIN32__
                                         , mutex
#endif
                                         )),
      verbose(verbose_)
{
}

int
TcpServer::get_listening_socket(const std::string & host, int port,
                                bool tcp_nodelay
#if defined __CYGWIN__ || defined __WIN32__
                                , HANDLE &mutex
#endif
                                )
{
    int socketfd = socket(PF_INET, SOCK_STREAM, 0);

    if (socketfd < 0) {
        throw Xapian::NetworkError("socket", socket_errno());
    }

    int retval = 0;

    if (tcp_nodelay) {
        int optval = 1;
        // 4th argument might need to be void* or char* - cast it to char*
        // since C++ allows implicit conversion to void* but not from void*.
        retval = setsockopt(socketfd, IPPROTO_TCP, TCP_NODELAY,
                            reinterpret_cast<char *>(&optval),
                            sizeof(optval));
    }

    {
        int optval = 1;
#if defined __CYGWIN__ || defined __WIN32__
        // Windows has screwy semantics for SO_REUSEADDR - it allows the user
        // to bind to a port which is already bound and listening!  That's
        // just not suitable as we don't want multiple processes listening on
        // the same port, so we guard against that by using a named win32 mutex
        // object (and we create it in the 'Global namespace' so that this
        // still works in a Terminal Services environment).
        char name[64];
        sprintf(name, "Global\\xapian-tcpserver-listening-%d", port);
        if ((mutex = CreateMutex(NULL, TRUE, name)) == NULL) {
            // We failed to create the mutex, probably the error is
            // ERROR_ACCESS_DENIED, which simply means that TcpServer is
            // already running on this port but as a different user.
        } else if (GetLastError() == ERROR_ALREADY_EXISTS) {
            // The mutex already existed, so TcpServer is already running
            // on this port.
            CloseHandle(mutex);
            mutex = NULL;
        }
        if (mutex == NULL) {
            cerr << "Server is already running on port " << port << endl;
            // 69 is EX_UNAVAILABLE.  Scripts can use this to detect if the
            // server failed to bind to the requested port.
            exit(69); // FIXME: calling exit() here isn't ideal...
        }
#endif
        if (retval >= 0) {
            retval = setsockopt(socketfd, SOL_SOCKET, SO_REUSEADDR,
                                reinterpret_cast<char *>(&optval),
                                sizeof(optval));
        }

#if defined SO_EXCLUSIVEADDRUSE
        // NT4 sp4 and later offer SO_EXCLUSIVEADDRUSE which nullifies the
        // security issues from SO_REUSEADDR (which affect *any* listening
        // process, even if doesn't use SO_REUSEADDR itself).  There's still no
        // way of addressing the issue of not being able to listen on a port
        // which has closed connections in TIME_WAIT state though.
        //
        // Note: SO_EXCLUSIVEADDRUSE requires admin privileges prior to XP SP2.
        // Because of this and the lack support on older versions, we don't
        // currently check the return value.
        if (retval >= 0) {
            (void)setsockopt(socketfd, SOL_SOCKET, SO_EXCLUSIVEADDRUSE,
                             reinterpret_cast<char *>(&optval),
                             sizeof(optval));
        }
#endif
    }

    if (retval < 0) {
        int saved_errno = socket_errno(); // note down in case close hits an error
        CLOSESOCKET(socketfd);
        throw Xapian::NetworkError("setsockopt failed", saved_errno);
    }

    struct sockaddr_in addr;
    memset(&addr, 0, sizeof(addr));
    addr.sin_family = AF_INET;
    addr.sin_port = htons(port);
    if (host.empty()) {
        addr.sin_addr.s_addr = INADDR_ANY;
    } else {
        // FIXME: timeout on gethostbyname() ?
        struct hostent *hostent = gethostbyname(host.c_str());

        if (hostent == 0) {
            throw Xapian::NetworkError(string("Couldn't resolve host ") + host,
#ifdef __WIN32__
                socket_errno()
#else
                // "socket_errno()" is just errno on UNIX which is
                // inappropriate here - if gethostbyname() returns NULL an
                // error code is available in h_errno (with values
                // incompatible with errno).  On Linux at least, if h_errno
                // is < 0, then the error code *IS* in errno!
                (h_errno < 0 ? errno : -h_errno)
#endif
                );
        }

        memcpy(&addr.sin_addr, hostent->h_addr, hostent->h_length);
    }

    retval = bind(socketfd,
                  reinterpret_cast<sockaddr *>(&addr),
                  sizeof(addr));

    if (retval < 0) {
        int saved_errno = socket_errno(); // note down in case close hits an error
        if (saved_errno == EADDRINUSE) {
            cerr << host << ':' << port << " already in use" << endl;
            // 69 is EX_UNAVAILABLE.  Scripts can use this to detect if the
            // server failed to bind to the requested port.
            exit(69); // FIXME: calling exit() here isn't ideal...
        }
        if (saved_errno == EACCES) {
            cerr << "Can't bind to privileged port " << port << endl;
            // 77 is EX_NOPERM.  Scripts can use this to detect if
            // xapian-tcpsrv failed to bind to the requested port.
            exit(77); // FIXME: calling exit() here isn't ideal...
        }
        CLOSESOCKET(socketfd);
        throw Xapian::NetworkError("bind failed", saved_errno);
    }

    retval = listen(socketfd, 5);

    if (retval < 0) {
        int saved_errno = socket_errno(); // note down in case close hits an error
        CLOSESOCKET(socketfd);
        throw Xapian::NetworkError("listen failed", saved_errno);
    }
    return socketfd;
}

int
TcpServer::accept_connection()
{
    struct sockaddr_in remote_address;
    SOCKLEN_T remote_address_size = sizeof(remote_address);
    // accept connections
    int con_socket = accept(listen_socket,
                            reinterpret_cast<sockaddr *>(&remote_address),
                            &remote_address_size);

    if (con_socket < 0) {
#ifdef __WIN32__
        if (WSAGetLastError() == WSAEINTR) {
            // Our CtrlHandler function closed the socket.
            if (mutex) CloseHandle(mutex);
            mutex = NULL;
            return -1;
        }
#endif
        throw Xapian::NetworkError("accept failed", socket_errno());
    }

    if (remote_address_size != sizeof(remote_address)) {
        throw Xapian::NetworkError("accept: unexpected remote address size");
    }

    if (verbose) {
        cout << "Connection from " << inet_ntoa(remote_address.sin_addr)
             << ", port " << remote_address.sin_port << endl;
    }

    return con_socket;
}

TcpServer::~TcpServer()
{
    CLOSESOCKET(listen_socket);
#if defined __CYGWIN__ || defined __WIN32__
    if (mutex) CloseHandle(mutex);
#endif
}

#ifdef HAVE_FORK
// A fork() based implementation.
void
TcpServer::run_once()
{
    int connected_socket = accept_connection();
    pid_t pid = fork();
    if (pid == 0) {
        // Child process.
        close(listen_socket);

        handle_one_connection(connected_socket);
        close(connected_socket);

        if (verbose) cout << "Closing connection." << endl;
        exit(0);
    }

    // Parent process.

    if (pid < 0) {
        // fork() failed
        int saved_errno = socket_errno(); // note down in case close hits an error
        close(connected_socket);
        throw Xapian::NetworkError("fork failed", saved_errno);
    }

    close(connected_socket);
}

extern "C" {

XAPIAN_NORETURN(static void on_SIGTERM(int /*sig*/));

static void
on_SIGTERM(int /*sig*/)
{
    signal(SIGTERM, SIG_DFL);
    /* terminate all processes in my process group */
#ifdef HAVE_KILLPG
    killpg(0, SIGTERM);
#else
    kill(0, SIGTERM);
#endif
    exit(0);
}

#ifdef HAVE_WAITPID
static void
on_SIGCHLD(int /*sig*/)
{
    int status;
    while (waitpid(-1, &status, WNOHANG) > 0);
}
#endif

}

void
TcpServer::run()
{
    // Handle connections until shutdown.

    // Set up signal handlers.
#ifdef HAVE_WAITPID
    signal(SIGCHLD, on_SIGCHLD);
#else
    signal(SIGCHLD, SIG_IGN);
#endif
    signal(SIGTERM, on_SIGTERM);

    while (true) {
        try {
            run_once();
        } catch (const Xapian::Error &e) {
            // FIXME: better error handling.
            cerr << "Caught " << e.get_description() << endl;
        } catch (...) {
            // FIXME: better error handling.
            cerr << "Caught exception." << endl;
        }
    }
}

#elif defined __WIN32__

// A threaded, Windows specific, implementation.

static const int *pShutdownSocket = NULL;

static BOOL
CtrlHandler(DWORD fdwCtrlType)
{
    switch (fdwCtrlType) {
        case CTRL_C_EVENT:
        case CTRL_CLOSE_EVENT:
            //  Console is about to die.
            // CTRL_CLOSE_EVENT gives us 5 seconds before displaying a
            // confirmation dialog asking if we really are sure.
        case CTRL_LOGOFF_EVENT:
        case CTRL_SHUTDOWN_EVENT:
            // These 2 will probably need to change when we get service
            // support - the service will prevent these being seen, so only
            // apply interactively.
            cout << "Shutting down..." << endl;
            break; // default behaviour
        case CTRL_BREAK_EVENT:
            // This (probably) means the developer is struggling to get
            // things to behave, and really wants to shutdown so let the OS
            // handle Ctrl+Break in the default way.
            cout << "Ctrl+Break: aborting process" << endl;
            return FALSE;
        default:
            cerr << "unexpected CtrlHandler: " << fdwCtrlType << endl;
            return FALSE;
    }

    // Note: close() does not cause a blocking accept() call to terminate.
    // However, it appears closesocket() does.  This is much easier than trying
    // to setup a non-blocking accept().
    if (!pShutdownSocket || closesocket(*pShutdownSocket) == SOCKET_ERROR) {
       // We failed to close the socket, so just let the OS handle the
       // event in the default way.
       return FALSE;
    }

    pShutdownSocket = NULL;
    return TRUE; // Tell the OS that we've handled the event.
}

struct thread_param
{
    thread_param(TcpServer *s, int c) : server(s), connected_socket(c) {}
    TcpServer *server;
    int connected_socket;
};

static unsigned __stdcall
run_thread(void * param_)
{
    thread_param * param(reinterpret_cast<thread_param *>(param_));
    int socket = param->connected_socket;

    param->server->handle_one_connection(socket);
    closesocket(socket);

    delete param;

    _endthreadex(0);
    return 0;
}

void
TcpServer::run()
{
    // Handle connections until shutdown.

    // Set up the shutdown handler - this is a bit hacky, and sadly involves
    // a global variable.
    pShutdownSocket = &listen_socket;
    if (!::SetConsoleCtrlHandler((PHANDLER_ROUTINE) CtrlHandler, TRUE))
        throw Xapian::NetworkError("Failed to install shutdown handler");

    while (true) {
        try {
            int connected_socket = accept_connection();
            if (connected_socket == -1)
               return; // Shutdown has happened

            // Spawn a new thread to handle the connection.
            // (This seems like lots of hoops just to end up calling
            // this->handle_one_connection() on a new thread. There might be a
            // better way...)
            thread_param *param = new thread_param(this, connected_socket);
            HANDLE hthread = (HANDLE)_beginthreadex(NULL, 0, ::run_thread, param, 0, NULL);
            if (hthread == 0) {
               // errno holds the error code from _beginthreadex, and
               // closesocket() doesn't set errno.
               closesocket(connected_socket);
               throw Xapian::NetworkError("_beginthreadex failed", errno);
            }

            // FIXME: keep track of open thread handles so we can gracefully
            // close each thread down.  OTOH, when we want to kill them all its
            // likely to mean the process is on its way down, so it doesn't
            // really matter...
            CloseHandle(hthread);
        } catch (const Xapian::Error &e) {
            // FIXME: better error handling.
            cerr << "Caught " << e.get_description() << endl;
        } catch (...) {
            // FIXME: better error handling.
            cerr << "Caught exception." << endl;
        }
    }
}

void
TcpServer::run_once()
{
    // Run a single request on the current thread.
    int fd = accept_connection();
    handle_one_connection(fd);
    closesocket(fd);
}

#else
# error Neither HAVE_FORK nor __WIN32__ are defined.
#endif

---