epoll.cpp 5.71 KB
Newer Older
Martin Sustrik's avatar
Martin Sustrik committed
1
/*
2
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
Martin Sustrik's avatar
Martin Sustrik committed
3

4
    This file is part of libzmq, the ZeroMQ core engine in C++.
Martin Sustrik's avatar
Martin Sustrik committed
5

6 7 8
    libzmq is free software; you can redistribute it and/or modify it under
    the terms of the GNU Lesser General Public License (LGPL) as published
    by the Free Software Foundation; either version 3 of the License, or
Martin Sustrik's avatar
Martin Sustrik committed
9 10
    (at your option) any later version.

11 12 13 14 15 16 17 18 19 20 21 22 23 24
    As a special exception, the Contributors give you permission to link
    this library with independent modules to produce an executable,
    regardless of the license terms of these independent modules, and to
    copy and distribute the resulting executable under terms of your choice,
    provided that you also meet, for each linked independent module, the
    terms and conditions of the license of that module. An independent
    module is a module which is not derived from or based on this library.
    If you modify this library, you must extend this exception to your
    version of the library.

    libzmq 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 Lesser General Public
    License for more details.
Martin Sustrik's avatar
Martin Sustrik committed
25

26
    You should have received a copy of the GNU Lesser General Public License
Martin Sustrik's avatar
Martin Sustrik committed
27 28 29
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

30
#include "precompiled.hpp"
31 32
#include "epoll.hpp"
#if defined ZMQ_USE_EPOLL
Martin Sustrik's avatar
Martin Sustrik committed
33 34 35 36 37 38

#include <sys/epoll.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <algorithm>
39
#include <new>
Martin Sustrik's avatar
Martin Sustrik committed
40

41
#include "macros.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
42 43 44 45 46
#include "epoll.hpp"
#include "err.hpp"
#include "config.hpp"
#include "i_poll_events.hpp"

47 48
zmq::epoll_t::epoll_t (const zmq::ctx_t &ctx_) :
    ctx(ctx_),
Martin Sustrik's avatar
Martin Sustrik committed
49 50
    stopping (false)
{
51 52 53 54 55 56
#ifdef ZMQ_USE_EPOLL_CLOEXEC
    //  Setting this option result in sane behaviour when exec() functions
    //  are used. Old sockets are closed and don't block TCP ports, avoid
    //  leaks, etc.
    epoll_fd = epoll_create1 (EPOLL_CLOEXEC);
#else
Martin Sustrik's avatar
Martin Sustrik committed
57
    epoll_fd = epoll_create (1);
58
#endif
Martin Sustrik's avatar
Martin Sustrik committed
59 60 61
    errno_assert (epoll_fd != -1);
}

Martin Sustrik's avatar
Martin Sustrik committed
62
zmq::epoll_t::~epoll_t ()
Martin Sustrik's avatar
Martin Sustrik committed
63
{
64 65 66
    //  Wait till the worker thread exits.
    worker.stop ();

67
    close (epoll_fd);
68 69 70
    for (retired_t::iterator it = retired.begin (); it != retired.end (); ++it) {
        LIBZMQ_DELETE(*it);
    }
Martin Sustrik's avatar
Martin Sustrik committed
71 72
}

73
zmq::epoll_t::handle_t zmq::epoll_t::add_fd (fd_t fd_, i_poll_events *events_)
Martin Sustrik's avatar
Martin Sustrik committed
74
{
75
    poll_entry_t *pe = new (std::nothrow) poll_entry_t;
76
    alloc_assert (pe);
Martin Sustrik's avatar
Martin Sustrik committed
77 78 79 80 81 82 83 84 85 86 87 88 89 90

    //  The memset is not actually needed. It's here to prevent debugging
    //  tools to complain about using uninitialised memory.
    memset (pe, 0, sizeof (poll_entry_t));

    pe->fd = fd_;
    pe->ev.events = 0;
    pe->ev.data.ptr = pe;
    pe->events = events_;

    int rc = epoll_ctl (epoll_fd, EPOLL_CTL_ADD, fd_, &pe->ev);
    errno_assert (rc != -1);

    //  Increase the load metric of the thread.
91
    adjust_load (1);
Martin Sustrik's avatar
Martin Sustrik committed
92

93
    return pe;
Martin Sustrik's avatar
Martin Sustrik committed
94 95
}

Martin Sustrik's avatar
Martin Sustrik committed
96
void zmq::epoll_t::rm_fd (handle_t handle_)
Martin Sustrik's avatar
Martin Sustrik committed
97
{
98
    poll_entry_t *pe = (poll_entry_t*) handle_;
Martin Sustrik's avatar
Martin Sustrik committed
99 100 101
    int rc = epoll_ctl (epoll_fd, EPOLL_CTL_DEL, pe->fd, &pe->ev);
    errno_assert (rc != -1);
    pe->fd = retired_fd;
102
    retired_sync.lock ();
Martin Sustrik's avatar
Martin Sustrik committed
103
    retired.push_back (pe);
104
    retired_sync.unlock ();
Martin Sustrik's avatar
Martin Sustrik committed
105 106

    //  Decrease the load metric of the thread.
107
    adjust_load (-1);
Martin Sustrik's avatar
Martin Sustrik committed
108 109
}

Martin Sustrik's avatar
Martin Sustrik committed
110
void zmq::epoll_t::set_pollin (handle_t handle_)
Martin Sustrik's avatar
Martin Sustrik committed
111
{
112
    poll_entry_t *pe = (poll_entry_t*) handle_;
Martin Sustrik's avatar
Martin Sustrik committed
113 114 115 116 117
    pe->ev.events |= EPOLLIN;
    int rc = epoll_ctl (epoll_fd, EPOLL_CTL_MOD, pe->fd, &pe->ev);
    errno_assert (rc != -1);
}

Martin Sustrik's avatar
Martin Sustrik committed
118
void zmq::epoll_t::reset_pollin (handle_t handle_)
Martin Sustrik's avatar
Martin Sustrik committed
119
{
120
    poll_entry_t *pe = (poll_entry_t*) handle_;
Martin Sustrik's avatar
Martin Sustrik committed
121 122 123 124 125
    pe->ev.events &= ~((short) EPOLLIN);
    int rc = epoll_ctl (epoll_fd, EPOLL_CTL_MOD, pe->fd, &pe->ev);
    errno_assert (rc != -1);
}

Martin Sustrik's avatar
Martin Sustrik committed
126
void zmq::epoll_t::set_pollout (handle_t handle_)
Martin Sustrik's avatar
Martin Sustrik committed
127
{
128
    poll_entry_t *pe = (poll_entry_t*) handle_;
Martin Sustrik's avatar
Martin Sustrik committed
129 130 131 132 133
    pe->ev.events |= EPOLLOUT;
    int rc = epoll_ctl (epoll_fd, EPOLL_CTL_MOD, pe->fd, &pe->ev);
    errno_assert (rc != -1);
}

Martin Sustrik's avatar
Martin Sustrik committed
134
void zmq::epoll_t::reset_pollout (handle_t handle_)
Martin Sustrik's avatar
Martin Sustrik committed
135
{
136
    poll_entry_t *pe = (poll_entry_t*) handle_;
Martin Sustrik's avatar
Martin Sustrik committed
137 138 139 140 141
    pe->ev.events &= ~((short) EPOLLOUT);
    int rc = epoll_ctl (epoll_fd, EPOLL_CTL_MOD, pe->fd, &pe->ev);
    errno_assert (rc != -1);
}

Martin Sustrik's avatar
Martin Sustrik committed
142
void zmq::epoll_t::start ()
Martin Sustrik's avatar
Martin Sustrik committed
143
{
144
    ctx.start_thread (worker, worker_routine, this);
Martin Sustrik's avatar
Martin Sustrik committed
145 146
}

Martin Sustrik's avatar
Martin Sustrik committed
147
void zmq::epoll_t::stop ()
Martin Sustrik's avatar
Martin Sustrik committed
148 149 150 151
{
    stopping = true;
}

Richard Newton's avatar
Richard Newton committed
152
int zmq::epoll_t::max_fds ()
153 154 155 156
{
    return -1;
}

Martin Sustrik's avatar
Martin Sustrik committed
157
void zmq::epoll_t::loop ()
Martin Sustrik's avatar
Martin Sustrik committed
158 159 160 161 162
{
    epoll_event ev_buf [max_io_events];

    while (!stopping) {

163
        //  Execute any due timers.
164
        int timeout = (int) execute_timers ();
Martin Sustrik's avatar
Martin Sustrik committed
165

166 167 168
        //  Wait for events.
        int n = epoll_wait (epoll_fd, &ev_buf [0], max_io_events,
            timeout ? timeout : -1);
Martin Hurton's avatar
Martin Hurton committed
169 170
        if (n == -1) {
            errno_assert (errno == EINTR);
Martin Sustrik's avatar
Martin Sustrik committed
171
            continue;
Martin Hurton's avatar
Martin Hurton committed
172
        }
Martin Sustrik's avatar
Martin Sustrik committed
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191

        for (int i = 0; i < n; i ++) {
            poll_entry_t *pe = ((poll_entry_t*) ev_buf [i].data.ptr);

            if (pe->fd == retired_fd)
                continue;
            if (ev_buf [i].events & (EPOLLERR | EPOLLHUP))
                pe->events->in_event ();
            if (pe->fd == retired_fd)
               continue;
            if (ev_buf [i].events & EPOLLOUT)
                pe->events->out_event ();
            if (pe->fd == retired_fd)
                continue;
            if (ev_buf [i].events & EPOLLIN)
                pe->events->in_event ();
        }

        //  Destroy retired event sources.
192
        retired_sync.lock ();
193 194 195
        for (retired_t::iterator it = retired.begin (); it != retired.end (); ++it) {
            LIBZMQ_DELETE(*it);
        }
Martin Sustrik's avatar
Martin Sustrik committed
196
        retired.clear ();
197
        retired_sync.unlock ();
Martin Sustrik's avatar
Martin Sustrik committed
198 199 200
    }
}

Martin Sustrik's avatar
Martin Sustrik committed
201
void zmq::epoll_t::worker_routine (void *arg_)
Martin Sustrik's avatar
Martin Sustrik committed
202 203 204 205 206
{
    ((epoll_t*) arg_)->loop ();
}

#endif