epoll.cpp 5.88 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

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

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

48
zmq::epoll_t::epoll_t (const zmq::thread_ctx_t &ctx_) :
49
    worker_poller_base_t (ctx_)
Martin Sustrik's avatar
Martin Sustrik committed
50
{
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
    //  Wait till the worker thread exits.
65
    stop_worker ();
66

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

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

    //  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.
93
    adjust_load (1);
Martin Sustrik's avatar
Martin Sustrik committed
94

95
    return pe;
Martin Sustrik's avatar
Martin Sustrik committed
96 97
}

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

    //  Decrease the load metric of the thread.
110
    adjust_load (-1);
Martin Sustrik's avatar
Martin Sustrik committed
111 112
}

Martin Sustrik's avatar
Martin Sustrik committed
113
void zmq::epoll_t::set_pollin (handle_t handle_)
Martin Sustrik's avatar
Martin Sustrik committed
114
{
115
    check_thread ();
116
    poll_entry_t *pe = (poll_entry_t *) handle_;
Martin Sustrik's avatar
Martin Sustrik committed
117 118 119 120 121
    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
122
void zmq::epoll_t::reset_pollin (handle_t handle_)
Martin Sustrik's avatar
Martin Sustrik committed
123
{
124
    check_thread ();
125
    poll_entry_t *pe = (poll_entry_t *) handle_;
Martin Sustrik's avatar
Martin Sustrik committed
126 127 128 129 130
    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
131
void zmq::epoll_t::set_pollout (handle_t handle_)
Martin Sustrik's avatar
Martin Sustrik committed
132
{
133
    check_thread ();
134
    poll_entry_t *pe = (poll_entry_t *) handle_;
Martin Sustrik's avatar
Martin Sustrik committed
135 136 137 138 139
    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
140
void zmq::epoll_t::reset_pollout (handle_t handle_)
Martin Sustrik's avatar
Martin Sustrik committed
141
{
142
    check_thread ();
143
    poll_entry_t *pe = (poll_entry_t *) handle_;
Martin Sustrik's avatar
Martin Sustrik committed
144 145 146 147 148
    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
149
void zmq::epoll_t::stop ()
Martin Sustrik's avatar
Martin Sustrik committed
150
{
151
    check_thread ();
Martin Sustrik's avatar
Martin Sustrik committed
152 153
}

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

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

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

167 168 169 170 171 172 173 174
        if (get_load () == 0) {
            if (timeout == 0)
                break;

            // TODO sleep for timeout
            continue;
        }

175
        //  Wait for events.
176 177
        int n = epoll_wait (epoll_fd, &ev_buf[0], max_io_events,
                            timeout ? timeout : -1);
Martin Hurton's avatar
Martin Hurton committed
178 179
        if (n == -1) {
            errno_assert (errno == EINTR);
Martin Sustrik's avatar
Martin Sustrik committed
180
            continue;
Martin Hurton's avatar
Martin Hurton committed
181
        }
Martin Sustrik's avatar
Martin Sustrik committed
182

183 184
        for (int i = 0; i < n; i++) {
            poll_entry_t *pe = ((poll_entry_t *) ev_buf[i].data.ptr);
Martin Sustrik's avatar
Martin Sustrik committed
185 186 187

            if (pe->fd == retired_fd)
                continue;
188
            if (ev_buf[i].events & (EPOLLERR | EPOLLHUP))
Martin Sustrik's avatar
Martin Sustrik committed
189 190
                pe->events->in_event ();
            if (pe->fd == retired_fd)
191 192
                continue;
            if (ev_buf[i].events & EPOLLOUT)
Martin Sustrik's avatar
Martin Sustrik committed
193 194 195
                pe->events->out_event ();
            if (pe->fd == retired_fd)
                continue;
196
            if (ev_buf[i].events & EPOLLIN)
Martin Sustrik's avatar
Martin Sustrik committed
197 198 199 200
                pe->events->in_event ();
        }

        //  Destroy retired event sources.
201
        retired_sync.lock ();
202 203 204
        for (retired_t::iterator it = retired.begin (); it != retired.end ();
             ++it) {
            LIBZMQ_DELETE (*it);
205
        }
Martin Sustrik's avatar
Martin Sustrik committed
206
        retired.clear ();
207
        retired_sync.unlock ();
Martin Sustrik's avatar
Martin Sustrik committed
208 209 210 211
    }
}

#endif