kqueue.cpp 5.9 KB
Newer Older
Martin Sustrik's avatar
Martin Sustrik committed
1
/*
2
    Copyright (c) 2007-2015 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 31
#include "kqueue.hpp"
#if defined ZMQ_USE_KQUEUE
Martin Sustrik's avatar
Martin Sustrik committed
32 33 34 35 36 37 38

#include <sys/time.h>
#include <sys/types.h>
#include <sys/event.h>
#include <stdlib.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
#include "kqueue.hpp"
#include "err.hpp"
#include "config.hpp"
#include "i_poll_events.hpp"
46
#include "likely.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
47

Martin Lucina's avatar
Martin Lucina committed
48 49 50 51 52 53 54 55
//  NetBSD defines (struct kevent).udata as intptr_t, everyone else
//  as void *.
#if defined ZMQ_HAVE_NETBSD
#define kevent_udata_t intptr_t
#else
#define kevent_udata_t void *
#endif

56 57
zmq::kqueue_t::kqueue_t (const zmq::ctx_t &ctx_) :
    ctx(ctx_),
58
    stopping (false)
Martin Sustrik's avatar
Martin Sustrik committed
59 60 61 62
{
    //  Create event queue
    kqueue_fd = kqueue ();
    errno_assert (kqueue_fd != -1);
63 64 65
#ifdef HAVE_FORK
    pid = getpid();
#endif
Martin Sustrik's avatar
Martin Sustrik committed
66 67
}

Martin Sustrik's avatar
Martin Sustrik committed
68
zmq::kqueue_t::~kqueue_t ()
Martin Sustrik's avatar
Martin Sustrik committed
69
{
70
    worker.stop ();
Martin Sustrik's avatar
Martin Sustrik committed
71 72 73
    close (kqueue_fd);
}

Martin Sustrik's avatar
Martin Sustrik committed
74
void zmq::kqueue_t::kevent_add (fd_t fd_, short filter_, void *udata_)
Martin Sustrik's avatar
Martin Sustrik committed
75 76 77
{
    struct kevent ev;

Martin Lucina's avatar
Martin Lucina committed
78
    EV_SET (&ev, fd_, filter_, EV_ADD, 0, 0, (kevent_udata_t)udata_);
Martin Sustrik's avatar
Martin Sustrik committed
79 80 81 82
    int rc = kevent (kqueue_fd, &ev, 1, NULL, 0, NULL);
    errno_assert (rc != -1);
}

Martin Sustrik's avatar
Martin Sustrik committed
83
void zmq::kqueue_t::kevent_delete (fd_t fd_, short filter_)
Martin Sustrik's avatar
Martin Sustrik committed
84 85 86
{
    struct kevent ev;

87
    EV_SET (&ev, fd_, filter_, EV_DELETE, 0, 0, 0);
Martin Sustrik's avatar
Martin Sustrik committed
88 89 90 91
    int rc = kevent (kqueue_fd, &ev, 1, NULL, 0, NULL);
    errno_assert (rc != -1);
}

92 93
zmq::kqueue_t::handle_t zmq::kqueue_t::add_fd (fd_t fd_,
    i_poll_events *reactor_)
Martin Sustrik's avatar
Martin Sustrik committed
94
{
95
    poll_entry_t *pe = new (std::nothrow) poll_entry_t;
96
    alloc_assert (pe);
Martin Sustrik's avatar
Martin Sustrik committed
97 98 99 100 101 102

    pe->fd = fd_;
    pe->flag_pollin = 0;
    pe->flag_pollout = 0;
    pe->reactor = reactor_;

103 104
    adjust_load (1);

105
    return pe;
Martin Sustrik's avatar
Martin Sustrik committed
106 107
}

Martin Sustrik's avatar
Martin Sustrik committed
108
void zmq::kqueue_t::rm_fd (handle_t handle_)
Martin Sustrik's avatar
Martin Sustrik committed
109
{
110
    poll_entry_t *pe = (poll_entry_t*) handle_;
Martin Sustrik's avatar
Martin Sustrik committed
111 112 113 114 115 116
    if (pe->flag_pollin)
        kevent_delete (pe->fd, EVFILT_READ);
    if (pe->flag_pollout)
        kevent_delete (pe->fd, EVFILT_WRITE);
    pe->fd = retired_fd;
    retired.push_back (pe);
117 118

    adjust_load (-1);
Martin Sustrik's avatar
Martin Sustrik committed
119 120
}

Martin Sustrik's avatar
Martin Sustrik committed
121
void zmq::kqueue_t::set_pollin (handle_t handle_)
Martin Sustrik's avatar
Martin Sustrik committed
122
{
123
    poll_entry_t *pe = (poll_entry_t*) handle_;
124 125 126 127
    if (likely (!pe->flag_pollin)) {
        pe->flag_pollin = true;
        kevent_add (pe->fd, EVFILT_READ, pe);
    }
Martin Sustrik's avatar
Martin Sustrik committed
128 129
}

Martin Sustrik's avatar
Martin Sustrik committed
130
void zmq::kqueue_t::reset_pollin (handle_t handle_)
Martin Sustrik's avatar
Martin Sustrik committed
131
{
132
    poll_entry_t *pe = (poll_entry_t*) handle_;
133 134 135 136
    if (likely (pe->flag_pollin)) {
        pe->flag_pollin = false;
        kevent_delete (pe->fd, EVFILT_READ);
    }
Martin Sustrik's avatar
Martin Sustrik committed
137 138
}

Martin Sustrik's avatar
Martin Sustrik committed
139
void zmq::kqueue_t::set_pollout (handle_t handle_)
Martin Sustrik's avatar
Martin Sustrik committed
140
{
141
    poll_entry_t *pe = (poll_entry_t*) handle_;
142 143 144 145
    if (likely (!pe->flag_pollout)) {
        pe->flag_pollout = true;
        kevent_add (pe->fd, EVFILT_WRITE, pe);
    }
Martin Sustrik's avatar
Martin Sustrik committed
146 147
}

Martin Sustrik's avatar
Martin Sustrik committed
148
void zmq::kqueue_t::reset_pollout (handle_t handle_)
Martin Sustrik's avatar
Martin Sustrik committed
149
{
150
    poll_entry_t *pe = (poll_entry_t*) handle_;
151 152 153 154
    if (likely (pe->flag_pollout)) {
        pe->flag_pollout = false;
        kevent_delete (pe->fd, EVFILT_WRITE);
   }
Martin Sustrik's avatar
Martin Sustrik committed
155 156
}

Martin Sustrik's avatar
Martin Sustrik committed
157
void zmq::kqueue_t::start ()
Martin Sustrik's avatar
Martin Sustrik committed
158
{
159
    ctx.start_thread (worker, worker_routine, this);
Martin Sustrik's avatar
Martin Sustrik committed
160 161
}

Martin Sustrik's avatar
Martin Sustrik committed
162
void zmq::kqueue_t::stop ()
Martin Sustrik's avatar
Martin Sustrik committed
163 164 165 166
{
    stopping = true;
}

Richard Newton's avatar
Richard Newton committed
167
int zmq::kqueue_t::max_fds ()
168 169 170 171
{
    return -1;
}

Martin Sustrik's avatar
Martin Sustrik committed
172
void zmq::kqueue_t::loop ()
Martin Sustrik's avatar
Martin Sustrik committed
173 174 175
{
    while (!stopping) {

176
        //  Execute any due timers.
177
        int timeout = (int) execute_timers ();
Martin Sustrik's avatar
Martin Sustrik committed
178 179

        //  Wait for events.
180 181 182 183
        struct kevent ev_buf [max_io_events];
        timespec ts = {timeout / 1000, (timeout % 1000) * 1000000};
        int n = kevent (kqueue_fd, NULL, 0, &ev_buf [0], max_io_events,
            timeout ? &ts: NULL);
184 185 186 187 188 189 190
#ifdef HAVE_FORK
        if (unlikely(pid != getpid())) {
            //printf("zmq::kqueue_t::loop aborting on forked child %d\n", (int)getpid());
            // simply exit the loop in a forked process.
            return;
        }
#endif
Martin Hurton's avatar
Martin Hurton committed
191 192
        if (n == -1) {
            errno_assert (errno == EINTR);
Martin Sustrik's avatar
Martin Sustrik committed
193
            continue;
Martin Hurton's avatar
Martin Hurton committed
194
        }
Martin Sustrik's avatar
Martin Sustrik committed
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213

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

            if (pe->fd == retired_fd)
                continue;
            if (ev_buf [i].flags & EV_EOF)
                pe->reactor->in_event ();
            if (pe->fd == retired_fd)
                continue;
            if (ev_buf [i].filter == EVFILT_WRITE)
                pe->reactor->out_event ();
            if (pe->fd == retired_fd)
                continue;
            if (ev_buf [i].filter == EVFILT_READ)
                pe->reactor->in_event ();
        }

        //  Destroy retired event sources.
214 215 216
        for (retired_t::iterator it = retired.begin (); it != retired.end (); ++it) {
            LIBZMQ_DELETE(*it);
        }
Martin Sustrik's avatar
Martin Sustrik committed
217 218 219 220
        retired.clear ();
    }
}

Martin Sustrik's avatar
Martin Sustrik committed
221
void zmq::kqueue_t::worker_routine (void *arg_)
Martin Sustrik's avatar
Martin Sustrik committed
222 223 224 225 226
{
    ((kqueue_t*) arg_)->loop ();
}

#endif