socket_poller.cpp 18.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
/*
    Copyright (c) 2007-2015 Contributors as noted in the AUTHORS file

    This file is part of libzmq, the ZeroMQ core engine in C++.

    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
    (at your option) any later version.

    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.

    You should have received a copy of the GNU Lesser General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#include "socket_poller.hpp"
#include "err.hpp"

zmq::socket_poller_t::socket_poller_t () :
    tag (0xCAFEBABE),
35 36
    need_rebuild (true),
    use_signaler (false)
37
#if defined ZMQ_POLL_BASED_ON_POLL
38 39 40
    ,
    pollfds (NULL)
#endif
41
{
42 43 44 45 46
}

zmq::socket_poller_t::~socket_poller_t ()
{
    //  Mark the socket_poller as dead
47
    tag = 0xdeadbeef;
48

49
    for (items_t::iterator it = items.begin(); it != items.end(); ++it) {
50
        if (it->socket && it->socket->check_tag()) {
51 52 53
            int thread_safe;
            size_t thread_safe_size = sizeof(int);

54
            if (it->socket->getsockopt (ZMQ_THREAD_SAFE, &thread_safe, &thread_safe_size) == 0 && thread_safe)
55
                it->socket->remove_signaler (&signaler);
56 57 58
        }
    }

59 60 61 62
#if defined ZMQ_POLL_BASED_ON_POLL
    if (pollfds) {
        free (pollfds);
        pollfds = NULL;
63
    }
64
#endif
65 66
}

67
bool zmq::socket_poller_t::check_tag ()
68 69 70 71
{
    return tag == 0xCAFEBABE;
}

72
int zmq::socket_poller_t::add (socket_base_t *socket_, void* user_data_, short events_)
73
{
74
    for (items_t::iterator it = items.begin (); it != items.end (); ++it) {
75 76 77
        if (it->socket == socket_) {
            errno = EINVAL;
            return -1;
78
        }
79 80 81 82
    }

    int thread_safe;
    size_t thread_safe_size = sizeof(int);
83 84

    if (socket_->getsockopt (ZMQ_THREAD_SAFE, &thread_safe, &thread_safe_size) == -1)
85 86 87
        return -1;

    if (thread_safe) {
88
        if (socket_->add_signaler (&signaler) == -1)
89 90
           return -1;
    }
91

92 93
    item_t item = {socket_, 0, user_data_, events_};
    items.push_back (item);
94 95 96 97 98
    need_rebuild = true;

    return 0;
}

99
int zmq::socket_poller_t::add_fd (fd_t fd_, void *user_data_, short events_)
100
{
101
   for (items_t::iterator it = items.begin (); it != items.end (); ++it) {
102 103 104
        if (!it->socket && it->fd == fd_) {
            errno = EINVAL;
            return -1;
105
        }
106 107
    }

108 109
    item_t item = {NULL, fd_, user_data_, events_};
    items.push_back (item);
110 111 112 113 114
    need_rebuild = true;

    return 0;
}

115
int zmq::socket_poller_t::modify (socket_base_t  *socket_, short events_)
116
{
117
    items_t::iterator it;
118

119
    for (it = items.begin (); it != items.end (); ++it) {
120 121 122 123
        if (it->socket == socket_)
            break;
    }

124
    if (it == items.end()) {
125 126 127 128 129 130 131 132 133 134 135
        errno = EINVAL;
        return -1;
    }

    it->events = events_;
    need_rebuild = true;

    return 0;
}


136
int zmq::socket_poller_t::modify_fd (fd_t fd_, short events_)
137
{
138
    items_t::iterator it;
139

140
    for (it = items.begin (); it != items.end (); ++it) {
141 142 143 144
        if (!it->socket && it->fd == fd_)
            break;
    }

145
    if (it == items.end()) {
146 147 148
        errno = EINVAL;
        return -1;
    }
149

150 151 152 153
    it->events = events_;
    need_rebuild = true;

    return 0;
154
}
155 156


157
int zmq::socket_poller_t::remove (socket_base_t *socket_)
158
{
159
    items_t::iterator it;
160

161
    for (it = items.begin (); it != items.end (); ++it) {
162 163 164 165
        if (it->socket == socket_)
            break;
    }

166
    if (it == items.end()) {
167 168 169
        errno = EINVAL;
        return -1;
    }
170

171 172 173
    int thread_safe;
    size_t thread_safe_size = sizeof(int);

174
    if (socket_->getsockopt (ZMQ_THREAD_SAFE, &thread_safe, &thread_safe_size) == -1)
175 176 177
        return -1;

    if (thread_safe) {
178
        if (socket_->remove_signaler (&signaler) == -1)
179 180
            return -1;
    }
181

182
    items.erase (it);
183 184
    need_rebuild = true;

185 186 187
    return 0;
}

188
int zmq::socket_poller_t::remove_fd (fd_t fd_)
189
{
190
    items_t::iterator it;
191

192
    for (it = items.begin (); it != items.end (); ++it) {
193 194 195 196
        if (!it->socket && it->fd == fd_)
            break;
    }

197
    if (it == items.end()) {
198 199 200
        errno = EINVAL;
        return -1;
    }
201

202
    items.erase (it);
203 204 205
    need_rebuild = true;

    return 0;
206
}
207

208
int zmq::socket_poller_t::rebuild ()
209
{
210
#if defined ZMQ_POLL_BASED_ON_POLL
211

212 213 214 215
    if (pollfds) {
        free (pollfds);
        pollfds = NULL;
    }
216

217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
    use_signaler = false;

    poll_size = 0;

    for (items_t::iterator it = items.begin (); it != items.end (); ++it) {
        if (it->events) {
            if (it->socket) {
                int thread_safe;
                size_t thread_safe_size = sizeof(int);

                if (it->socket->getsockopt (ZMQ_THREAD_SAFE, &thread_safe, &thread_safe_size) == -1)
                    return -1;

                if (thread_safe) {
                    if (!use_signaler) {
                        use_signaler = true;
                        poll_size++;
234
                    }
235 236 237 238
                }
                else
                    poll_size++;
            }
239 240
            else
                poll_size++;
241
        }
242
    }
243

244 245
    if (poll_size == 0)
        return 0;
246

247 248 249 250 251 252 253 254 255
    pollfds = (pollfd*) malloc (poll_size * sizeof (pollfd));
    alloc_assert (pollfds);

    int item_nbr = 0;

    if (use_signaler) {
        item_nbr = 1;
        pollfds[0].fd = signaler.get_fd();
        pollfds[0].events = POLLIN;
256 257
    }

258
    for (items_t::iterator it = items.begin (); it != items.end (); ++it) {
259 260 261 262 263 264 265 266
        if (it->events) {
            if (it->socket) {
                int thread_safe;
                size_t thread_safe_size = sizeof(int);

                if (it->socket->getsockopt (ZMQ_THREAD_SAFE, &thread_safe, &thread_safe_size) == -1)
                    return -1;

267
                if (!thread_safe) {
268 269 270 271
                    size_t fd_size = sizeof (zmq::fd_t);
                    if (it->socket->getsockopt (ZMQ_FD, &pollfds [item_nbr].fd, &fd_size) == -1) {
                        return -1;
                    }
272

273 274 275 276 277 278 279 280 281 282 283
                    pollfds [item_nbr].events = POLLIN;
                    item_nbr++;
                }
            }
            else {
                pollfds [item_nbr].fd = it->fd;
                pollfds [item_nbr].events =
                    (it->events & ZMQ_POLLIN ? POLLIN : 0) |
                    (it->events & ZMQ_POLLOUT ? POLLOUT : 0) |
                    (it->events & ZMQ_POLLPRI ? POLLPRI : 0);
                it->pollfd_index = item_nbr;
284
                item_nbr++;
285 286 287
            }
        }
    }
288

289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
 #elif defined ZMQ_POLL_BASED_ON_SELECT

    FD_ZERO (&pollset_in);
    FD_ZERO (&pollset_out);
    FD_ZERO (&pollset_err);

    //  Ensure we do not attempt to select () on more than FD_SETSIZE
    //  file descriptors.
    zmq_assert (items.size () <= FD_SETSIZE);

    poll_size = 0;

    use_signaler = false;

    for (items_t::iterator it = items.begin (); it != items.end (); ++it) {
        if (it->socket) {
            int thread_safe;
            size_t thread_safe_size = sizeof(int);

            if (it->socket->getsockopt (ZMQ_THREAD_SAFE, &thread_safe, &thread_safe_size) == -1)
                return -1;

            if (thread_safe && it->events) {
                use_signaler = true;
                FD_SET (signaler.get_fd (), &pollset_in);
                poll_size = 1;
                break;
            }
317 318
        }
    }
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341

    maxfd = 0;

    //  Build the fd_sets for passing to select ().
    for (items_t::iterator it = items.begin (); it != items.end (); ++it) {
        if (it->events) {
            //  If the poll item is a 0MQ socket we are interested in input on the
            //  notification file descriptor retrieved by the ZMQ_FD socket option.
            if (it->socket) {
                int thread_safe;
                size_t thread_safe_size = sizeof(int);

                if (it->socket->getsockopt (ZMQ_THREAD_SAFE, &thread_safe, &thread_safe_size) == -1)
                    return -1;

                if (!thread_safe) {
                    zmq::fd_t notify_fd;
                    size_t fd_size = sizeof (zmq::fd_t);
                    if (it->socket->getsockopt (ZMQ_FD, &notify_fd, &fd_size) == -1)
                        return -1;

                    FD_SET (notify_fd, &pollset_in);
                    if (maxfd < notify_fd)
342
                        maxfd = notify_fd;
343

344
                    poll_size++;
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
                }
            }
            //  Else, the poll item is a raw file descriptor. Convert the poll item
            //  events to the appropriate fd_sets.
            else {
                if (it->events & ZMQ_POLLIN)
                    FD_SET (it->fd, &pollset_in);
                if (it->events & ZMQ_POLLOUT)
                    FD_SET (it->fd, &pollset_out);
                if (it->events & ZMQ_POLLERR)
                    FD_SET (it->fd, &pollset_err);
                if (maxfd < it->fd)
                    maxfd = it->fd;

                poll_size++;
            }
        }
    }

#endif

    need_rebuild = false;
367 368 369
    return 0;
}

370
int zmq::socket_poller_t::wait (zmq::socket_poller_t::event_t *event_, long timeout_)
371
{
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
    if (need_rebuild)
        if (rebuild () == -1)
            return -1;

#if defined ZMQ_POLL_BASED_ON_POLL
    if (unlikely (poll_size == 0)) {
        if (timeout_ == 0)
            return 0;
#if defined ZMQ_HAVE_WINDOWS
        Sleep (timeout_ > 0 ? timeout_ : INFINITE);
        return 0;
#elif defined ZMQ_HAVE_ANDROID
        usleep (timeout_ * 1000);
        return 0;
#else
        return usleep (timeout_ * 1000);
#endif
389 390
    }

391 392 393
    zmq::clock_t clock;
    uint64_t now = 0;
    uint64_t end = 0;
394

395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
    bool first_pass = true;

    while (true) {
        //  Compute the timeout for the subsequent poll.
        int timeout;
        if (first_pass)
            timeout = 0;
        else
        if (timeout_ < 0)
            timeout = -1;
        else
            timeout = end - now;

        //  Wait for events.
        while (true) {
            int rc = poll (pollfds, poll_size, timeout);
            if (rc == -1 && errno == EINTR) {
                return -1;
            }
            errno_assert (rc >= 0);
            break;
        }

        //  Receive the signal from pollfd
        if (use_signaler && pollfds[0].revents & POLLIN)
            signaler.recv ();

        //  Check for the events.
        for (items_t::iterator it = items.begin (); it != items.end (); ++it) {

            //  The poll item is a 0MQ socket. Retrieve pending events
            //  using the ZMQ_EVENTS socket option.
            if (it->socket) {
                size_t events_size = sizeof (uint32_t);
                uint32_t events;
                if (it->socket->getsockopt (ZMQ_EVENTS, &events, &events_size) == -1) {
                    return -1;
                }

                if (it->events & events) {
                    event_->socket = it->socket;
                    event_->user_data = it->user_data;
                    event_->events = it->events & events;

                    //  If there is event to return, we can exit immediately.
                    return 0;
441
                }
442 443 444 445 446
            }
            //  Else, the poll item is a raw file descriptor, simply convert
            //  the events to zmq_pollitem_t-style format.
            else {
                short revents = pollfds [it->pollfd_index].revents;
447 448
                short events = 0;

449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
                if (revents & POLLIN)
                    events |= ZMQ_POLLIN;
                if (revents & POLLOUT)
                    events |= ZMQ_POLLOUT;
                if (revents & POLLPRI)
                    events |= ZMQ_POLLPRI;
                if (revents & ~(POLLIN | POLLOUT | POLLPRI))
                    events |= ZMQ_POLLERR;

                if (events) {
                    event_->socket = NULL;
                    event_->user_data = it->user_data;
                    event_->fd = it->fd;
                    event_->events = events;

                    //  If there is event to return, we can exit immediately.
                    return 0;
                }
            }
        }

        //  If timeout is zero, exit immediately whether there are events or not.
        if (timeout_ == 0)
            break;

        //  At this point we are meant to wait for events but there are none.
        //  If timeout is infinite we can just loop until we get some events.
        if (timeout_ < 0) {
            if (first_pass)
                first_pass = false;
            continue;
        }

        //  The timeout is finite and there are no events. In the first pass
        //  we get a timestamp of when the polling have begun. (We assume that
        //  first pass have taken negligible time). We also compute the time
        //  when the polling should time out.
        if (first_pass) {
            now = clock.now_ms ();
            end = now + timeout_;
            if (now == end)
                break;
            first_pass = false;
            continue;
        }

        //  Find out whether timeout have expired.
        now = clock.now_ms ();
        if (now >= end)
            break;
499 500
    }

501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
    errno = ETIMEDOUT;
    return -1;

#elif defined ZMQ_POLL_BASED_ON_SELECT

    if (unlikely (poll_size == 0)) {
        if (timeout_ == 0)
            return 0;
#if defined ZMQ_HAVE_WINDOWS
        Sleep (timeout_ > 0 ? timeout_ : INFINITE);
        return 0;
#else
        return usleep (timeout_ * 1000);
#endif
    }
    zmq::clock_t clock;
    uint64_t now = 0;
    uint64_t end = 0;

520
    bool first_pass = true;
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
    fd_set inset, outset, errset;

    while (true) {

        //  Compute the timeout for the subsequent poll.
        timeval timeout;
        timeval *ptimeout;
        if (first_pass) {
            timeout.tv_sec = 0;
            timeout.tv_usec = 0;
            ptimeout = &timeout;
        }
        else
        if (timeout_ < 0)
            ptimeout = NULL;
        else {
            timeout.tv_sec = (long) ((end - now) / 1000);
            timeout.tv_usec = (long) ((end - now) % 1000 * 1000);
            ptimeout = &timeout;
        }

        //  Wait for events. Ignore interrupts if there's infinite timeout.
        while (true) {
            memcpy (&inset, &pollset_in, sizeof (fd_set));
            memcpy (&outset, &pollset_out, sizeof (fd_set));
            memcpy (&errset, &pollset_err, sizeof (fd_set));
#if defined ZMQ_HAVE_WINDOWS
            int rc = select (0, &inset, &outset, &errset, ptimeout);
            if (unlikely (rc == SOCKET_ERROR)) {
                errno = zmq::wsa_error_to_errno (WSAGetLastError ());
                wsa_assert (errno == ENOTSOCK);
                return -1;
            }
#else
            int rc = select (maxfd + 1, &inset, &outset, &errset, ptimeout);
            if (unlikely (rc == -1)) {
                errno_assert (errno == EINTR || errno == EBADF);
                return -1;
            }
#endif
            break;
        }

        if (use_signaler && FD_ISSET (signaler.get_fd (), &inset))
            signaler.recv ();

        //  Check for the events.
        for (items_t::iterator it = items.begin (); it != items.end (); ++it) {

            //  The poll item is a 0MQ socket. Retrieve pending events
            //  using the ZMQ_EVENTS socket option.
            if (it->socket) {
                size_t events_size = sizeof (uint32_t);
                uint32_t events;
                if (it->socket->getsockopt (ZMQ_EVENTS, &events, &events_size) == -1)
                    return -1;

                if (it->events & events) {
                    event_->socket = it->socket;
                    event_->user_data = it->user_data;
                    event_->events = it->events & events;

                    //  If there is event to return, we can exit immediately.
                    return 0;
585
                }
586 587 588 589 590 591 592 593 594 595 596 597
            }
            //  Else, the poll item is a raw file descriptor, simply convert
            //  the events to zmq_pollitem_t-style format.
            else {
                short events = 0;

                if (FD_ISSET (it->fd, &inset))
                    events |= ZMQ_POLLIN;
                if (FD_ISSET (it->fd, &outset))
                    events |= ZMQ_POLLOUT;
                if (FD_ISSET (it->fd, &errset))
                    events |= ZMQ_POLLERR;
598

599 600 601 602 603 604 605 606 607 608 609
                if (events) {
                    event_->socket = NULL;
                    event_->user_data = it->user_data;
                    event_->fd = it->fd;
                    event_->events = events;

                    //  If there is event to return, we can exit immediately.
                    return 0;
                }
            }
        }
610

611 612 613
        //  If timeout is zero, exit immediately whether there are events or not.
        if (timeout_ == 0)
            break;
614

615 616 617 618 619 620 621
        //  At this point we are meant to wait for events but there are none.
        //  If timeout is infinite we can just loop until we get some events.
        if (timeout_ < 0) {
            if (first_pass)
                first_pass = false;
            continue;
        }
622

623 624 625 626 627 628 629 630 631 632 633 634
        //  The timeout is finite and there are no events. In the first pass
        //  we get a timestamp of when the polling have begun. (We assume that
        //  first pass have taken negligible time). We also compute the time
        //  when the polling should time out.
        if (first_pass) {
            now = clock.now_ms ();
            end = now + timeout_;
            if (now == end)
                break;
            first_pass = false;
            continue;
        }
635

636 637 638 639
        //  Find out whether timeout have expired.
        now = clock.now_ms ();
        if (now >= end)
            break;
640 641
    }

642 643 644 645 646 647 648 649
    errno = ETIMEDOUT;
    return -1;

#else
    //  Exotic platforms that support neither poll() nor select().
    errno = ENOTSUP;
    return -1;
#endif
650
}