transmission/libtransmission/trevent.cc

/*
 * This file Copyright (C) 2007-2014 Mnemosyne LLC
 *
 * It may be used under the GNU GPL versions 2 or 3
 * or any future license endorsed by Mnemosyne LLC.
 *
 */

#include <cerrno>
#include <cstring>

#include <csignal>

#ifdef _WIN32
#include <winsock2.h>
#else
#include <unistd.h> /* read(), write(), pipe() */
#endif

#include <event2/dns.h>
#include <event2/event.h>

#include "transmission.h"
#include "log.h"
#include "net.h"
#include "session.h"

#include "transmission.h"
#include "platform.h" /* tr_lockLock() */
#include "tr-assert.h"
#include "trevent.h"
#include "utils.h"

#ifdef _WIN32

using tr_pipe_end_t = SOCKET;

static int pgpipe(tr_pipe_end_t handles[2])
{
    SOCKET s;
    struct sockaddr_in serv_addr;
    int len = sizeof(serv_addr);

    handles[0] = handles[1] = INVALID_SOCKET;

    if ((s = socket(AF_INET, SOCK_STREAM, 0)) == INVALID_SOCKET)
    {
        tr_logAddDebug("pgpipe failed to create socket: %ui", WSAGetLastError());
        return -1;
    }

    memset(&serv_addr, 0, sizeof(serv_addr));
    serv_addr.sin_family = AF_INET;
    serv_addr.sin_port = htons(0);
    serv_addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);

    if (bind(s, (SOCKADDR*)&serv_addr, len) == SOCKET_ERROR)
    {
        tr_logAddDebug("pgpipe failed to bind: %ui", WSAGetLastError());
        closesocket(s);
        return -1;
    }

    if (listen(s, 1) == SOCKET_ERROR)
    {
        tr_logAddNamedDbg("event", "pgpipe failed to listen: %ui", WSAGetLastError());
        closesocket(s);
        return -1;
    }

    if (getsockname(s, (SOCKADDR*)&serv_addr, &len) == SOCKET_ERROR)
    {
        tr_logAddDebug("pgpipe failed to getsockname: %ui", WSAGetLastError());
        closesocket(s);
        return -1;
    }

    if ((handles[1] = socket(PF_INET, SOCK_STREAM, 0)) == INVALID_SOCKET)
    {
        tr_logAddDebug("pgpipe failed to create socket 2: %ui", WSAGetLastError());
        closesocket(s);
        return -1;
    }

    if (connect(handles[1], (SOCKADDR*)&serv_addr, len) == SOCKET_ERROR)
    {
        tr_logAddDebug("pgpipe failed to connect socket: %ui", WSAGetLastError());
        closesocket(s);
        return -1;
    }

    if ((handles[0] = accept(s, (SOCKADDR*)&serv_addr, &len)) == INVALID_SOCKET)
    {
        tr_logAddDebug("pgpipe failed to accept socket: %ui", WSAGetLastError());
        closesocket(handles[1]);
        handles[1] = INVALID_SOCKET;
        closesocket(s);
        return -1;
    }

    closesocket(s);
    return 0;
}

static int piperead(tr_pipe_end_t s, void* buf, int len)
{
    int ret = recv(s, static_cast<char*>(buf), len, 0);

    if (ret == -1)
    {
        int const werror = WSAGetLastError();

        switch (werror)
        {
        /* simplified error mapping (not valid for connect) */
        case WSAEWOULDBLOCK:
            errno = EAGAIN;
            break;

        case WSAECONNRESET:
            /* EOF on the pipe! (win32 socket based implementation) */
            ret = 0;
            [[fallthrough]];

        default:
            errno = werror;
            break;
        }
    }
    else
    {
        errno = 0;
    }

    return ret;
}

#define pipe(a) pgpipe(a)
#define pipewrite(a, b, c) send(a, (char*)b, c, 0)

#else
using tr_pipe_end_t = int;
#define piperead(a, b, c) read(a, b, c)
#define pipewrite(a, b, c) write(a, b, c)
#endif

/***
****
***/

struct tr_event_handle
{
    bool die;
    tr_pipe_end_t fds[2];
    tr_lock* lock;
    tr_session* session;
    tr_thread* thread;
    struct event_base* base;
    struct event* pipeEvent;
};

struct tr_run_data
{
    void (*func)(void*);
    void* user_data;
};

#define dbgmsg(...) tr_logAddDeepNamed("event", __VA_ARGS__)

static void readFromPipe(evutil_socket_t fd, short eventType, void* veh)
{
    auto* eh = static_cast<tr_event_handle*>(veh);

    dbgmsg("readFromPipe: eventType is %hd", eventType);

    /* read the command type */
    char ch = '\0';

    int ret = 0;
    do
    {
        ret = piperead(fd, &ch, 1);
    } while (!eh->die && ret == -1 && errno == EAGAIN);

    dbgmsg("command is [%c], ret is %d, errno is %d", ch, ret, (int)errno);

    switch (ch)
    {
    case 'r': /* run in libevent thread */
        {
            struct tr_run_data data;
            size_t const nwant = sizeof(data);
            ev_ssize_t const ngot = piperead(fd, &data, nwant);

            if (!eh->die && ngot == (ev_ssize_t)nwant)
            {
                dbgmsg("invoking function in libevent thread");
                (*data.func)(data.user_data);
            }

            break;
        }

    case '\0': /* eof */
        {
            dbgmsg("pipe eof reached... removing event listener");
            event_free(eh->pipeEvent);
            tr_netCloseSocket(eh->fds[0]);
            event_base_loopexit(eh->base, nullptr);
            break;
        }

    default:
        {
            TR_ASSERT_MSG(false, "unhandled command type %d", (int)ch);
            break;
        }
    }
}

static void logFunc(int severity, char const* message)
{
    if (severity >= _EVENT_LOG_ERR)
    {
        tr_logAddError("%s", message);
    }
    else
    {
        tr_logAddDebug("%s", message);
    }
}

static void libeventThreadFunc(void* veh)
{
    auto* eh = static_cast<tr_event_handle*>(veh);

#ifndef _WIN32
    /* Don't exit when writing on a broken socket */
    signal(SIGPIPE, SIG_IGN);
#endif

    /* create the libevent bases */
    struct event_base* base = event_base_new();

    /* set the struct's fields */
    eh->base = base;
    eh->session->event_base = base;
    eh->session->evdns_base = evdns_base_new(base, true);
    eh->session->events = eh;

    /* listen to the pipe's read fd */
    eh->pipeEvent = event_new(base, eh->fds[0], EV_READ | EV_PERSIST, readFromPipe, veh);
    event_add(eh->pipeEvent, nullptr);
    event_set_log_callback(logFunc);

    /* loop until all the events are done */
    while (!eh->die)
    {
        event_base_dispatch(base);
    }

    /* shut down the thread */
    tr_lockFree(eh->lock);
    event_base_free(base);
    eh->session->events = nullptr;
    tr_free(eh);
    tr_logAddDebug("Closing libevent thread");
}

void tr_eventInit(tr_session* session)
{
    session->events = nullptr;

    auto* const eh = tr_new0(tr_event_handle, 1);
    eh->lock = tr_lockNew();

    if (pipe(eh->fds) == -1)
    {
        tr_logAddError("Unable to write to pipe() in libtransmission: %s", tr_strerror(errno));
    }

    eh->session = session;
    eh->thread = tr_threadNew(libeventThreadFunc, eh);

    /* wait until the libevent thread is running */
    while (session->events == nullptr)
    {
        tr_wait_msec(100);
    }
}

void tr_eventClose(tr_session* session)
{
    TR_ASSERT(tr_isSession(session));

    if (session->events == nullptr)
    {
        return;
    }

    session->events->die = true;
    if (tr_logGetDeepEnabled())
    {
        tr_logAddDeep(__FILE__, __LINE__, nullptr, "closing trevent pipe");
    }

    tr_netCloseSocket(session->events->fds[1]);
}

/**
***
**/

bool tr_amInEventThread(tr_session const* session)
{
    TR_ASSERT(tr_isSession(session));
    TR_ASSERT(session->events != nullptr);

    return tr_amInThread(session->events->thread);
}

/**
***
**/

void tr_runInEventThread(tr_session* session, void (*func)(void*), void* user_data)
{
    TR_ASSERT(tr_isSession(session));
    TR_ASSERT(session->events != nullptr);

    if (tr_amInThread(session->events->thread))
    {
        (*func)(user_data);
    }
    else
    {
        tr_event_handle* e = session->events;
        struct tr_run_data data;

        tr_lockLock(e->lock);

        tr_pipe_end_t const fd = e->fds[1];
        char ch = 'r';
        ev_ssize_t const res_1 = pipewrite(fd, &ch, 1);

        data.func = func;
        data.user_data = user_data;
        ev_ssize_t const res_2 = pipewrite(fd, &data, sizeof(data));

        tr_lockUnlock(e->lock);

        if (res_1 == -1 || res_2 == -1)
        {
            tr_logAddError("Unable to write to libtransmisison event queue: %s", tr_strerror(errno));
        }
    }
}