kqueue.cpp 5.93 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 "kqueue.hpp"
#if defined ZMQ_USE_KQUEUE
Martin Sustrik's avatar
Martin Sustrik committed
33 34 35 36 37 38 39

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

Martin Lucina's avatar
Martin Lucina committed
49 50 51 52 53 54 55 56
//  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

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

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

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

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

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

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

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

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

104 105
    adjust_load (1);

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

Martin Sustrik's avatar
Martin Sustrik committed
109
void zmq::kqueue_t::rm_fd (handle_t handle_)
Martin Sustrik's avatar
Martin Sustrik committed
110
{
111
    poll_entry_t *pe = (poll_entry_t*) handle_;
Martin Sustrik's avatar
Martin Sustrik committed
112 113 114 115 116 117
    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);
118 119

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

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

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

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

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

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

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

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

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

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

        //  Wait for events.
181 182 183 184
        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);
185 186 187 188 189 190 191
#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
192 193
        if (n == -1) {
            errno_assert (errno == EINTR);
Martin Sustrik's avatar
Martin Sustrik committed
194
            continue;
Martin Hurton's avatar
Martin Hurton committed
195
        }
Martin Sustrik's avatar
Martin Sustrik committed
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214

        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.
215 216 217
        for (retired_t::iterator it = retired.begin (); it != retired.end (); ++it) {
            LIBZMQ_DELETE(*it);
        }
Martin Sustrik's avatar
Martin Sustrik committed
218 219 220 221
        retired.clear ();
    }
}

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

#endif