udp_engine.cpp 15.3 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
/*
Copyright (c) 2007-2016 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 "precompiled.hpp"
31

32
#if !defined ZMQ_HAVE_WINDOWS
33
#include <sys/types.h>
34
#include <unistd.h>
35 36 37
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
38 39 40
#ifdef ZMQ_HAVE_VXWORKS
#include <sockLib.h>
#endif
41 42
#endif

43
#include "udp_address.hpp"
44 45 46 47 48
#include "udp_engine.hpp"
#include "session_base.hpp"
#include "err.hpp"
#include "ip.hpp"

49 50 51 52 53
//  OSX uses a different name for this socket option
#ifndef IPV6_ADD_MEMBERSHIP
#define IPV6_ADD_MEMBERSHIP IPV6_JOIN_GROUP
#endif

54
zmq::udp_engine_t::udp_engine_t (const options_t &options_) :
55
    plugged (false),
56 57
    fd (-1),
    session (NULL),
58
    handle (static_cast<handle_t> (NULL)),
59 60 61 62
    address (NULL),
    options (options_),
    send_enabled (false),
    recv_enabled (false)
63 64 65
{
}

66
zmq::udp_engine_t::~udp_engine_t ()
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
{
    zmq_assert (!plugged);

    if (fd != retired_fd) {
#ifdef ZMQ_HAVE_WINDOWS
        int rc = closesocket (fd);
        wsa_assert (rc != SOCKET_ERROR);
#else
        int rc = close (fd);
        errno_assert (rc == 0);
#endif
        fd = retired_fd;
    }
}

82
int zmq::udp_engine_t::init (address_t *address_, bool send_, bool recv_)
83 84 85 86 87 88 89
{
    zmq_assert (address_);
    zmq_assert (send_ || recv_);
    send_enabled = send_;
    recv_enabled = recv_;
    address = address_;

90 91
    fd = open_socket (address->resolved.udp_addr->family (), SOCK_DGRAM,
                      IPPROTO_UDP);
92 93 94 95 96 97 98 99
    if (fd == retired_fd)
        return -1;

    unblock_socket (fd);

    return 0;
}

100
void zmq::udp_engine_t::plug (io_thread_t *io_thread_, session_base_t *session_)
101 102 103 104 105 106 107 108 109 110 111 112
{
    zmq_assert (!plugged);
    plugged = true;

    zmq_assert (!session);
    zmq_assert (session_);
    session = session_;

    //  Connect to I/O threads poller object.
    io_object_t::plug (io_thread_);
    handle = add_fd (fd);

113
    const udp_address_t *const udp_addr = address->resolved.udp_addr;
114

115 116 117 118
    // Bind the socket to a device if applicable
    if (!options.bound_device.empty ())
        bind_to_device (fd, options.bound_device);

119 120
    if (send_enabled) {
        if (!options.raw_socket) {
121
            const ip_addr_t *out = udp_addr->target_addr ();
122 123
            out_address = out->as_sockaddr ();
            out_addrlen = out->sockaddr_len ();
124 125 126 127 128 129 130 131 132 133 134 135 136 137

            if (out->is_multicast ()) {
                int level;
                int optname;

                if (out->family () == AF_INET6) {
                    level = IPPROTO_IPV6;
                    optname = IPV6_MULTICAST_LOOP;
                } else {
                    level = IPPROTO_IP;
                    optname = IP_MULTICAST_LOOP;
                }

                int loop = options.multicast_loop;
138 139 140
                int rc =
                  setsockopt (fd, level, optname,
                              reinterpret_cast<char *> (&loop), sizeof (loop));
141

142 143 144 145 146 147 148 149 150 151 152 153 154
#ifdef ZMQ_HAVE_WINDOWS
                wsa_assert (rc != SOCKET_ERROR);
#else
                errno_assert (rc == 0);
#endif

                if (out->family () == AF_INET6) {
                    int bind_if = udp_addr->bind_if ();

                    if (bind_if > 0) {
                        //  If a bind interface is provided we tell the
                        //  kernel to use it to send multicast packets
                        rc = setsockopt (fd, IPPROTO_IPV6, IPV6_MULTICAST_IF,
155 156
                                         reinterpret_cast<char *> (&bind_if),
                                         sizeof (bind_if));
157 158 159 160 161 162 163 164
                    } else {
                        rc = 0;
                    }
                } else {
                    struct in_addr bind_addr =
                      udp_addr->bind_addr ()->ipv4.sin_addr;

                    if (bind_addr.s_addr != INADDR_ANY) {
165 166 167
                        rc = setsockopt (fd, IPPROTO_IP, IP_MULTICAST_IF,
                                         reinterpret_cast<char *> (&bind_addr),
                                         sizeof (bind_addr));
168 169 170 171 172
                    } else {
                        rc = 0;
                    }
                }

173 174 175 176 177 178
#ifdef ZMQ_HAVE_WINDOWS
                wsa_assert (rc != SOCKET_ERROR);
#else
                errno_assert (rc == 0);
#endif
            }
179
        } else {
180
            /// XXX fixme ?
181
            out_address = reinterpret_cast<sockaddr *> (&raw_address);
182 183 184
            out_addrlen = sizeof (sockaddr_in);
        }

185
        set_pollout (handle);
186
    }
187 188 189

    if (recv_enabled) {
        int on = 1;
190 191
        int rc = setsockopt (fd, SOL_SOCKET, SO_REUSEADDR,
                             reinterpret_cast<char *> (&on), sizeof (on));
192 193 194 195 196 197
#ifdef ZMQ_HAVE_WINDOWS
        wsa_assert (rc != SOCKET_ERROR);
#else
        errno_assert (rc == 0);
#endif

198
        const ip_addr_t *bind_addr = udp_addr->bind_addr ();
199 200 201
        ip_addr_t any = ip_addr_t::any (bind_addr->family ());
        const ip_addr_t *real_bind_addr;

202
        bool multicast = udp_addr->is_mcast ();
203 204 205 206 207 208 209 210 211 212 213

        if (multicast) {
            //  In multicast we should bind ANY and use the mreq struct to
            //  specify the interface
            any.set_port (bind_addr->port ());

            real_bind_addr = &any;
        } else {
            real_bind_addr = bind_addr;
        }

214
#ifdef ZMQ_HAVE_VXWORKS
215 216
        rc = bind (fd, (sockaddr *) real_bind_addr->as_sockaddr (),
                   real_bind_addr->sockaddr_len ());
217
#else
218 219 220
        rc = bind (fd, real_bind_addr->as_sockaddr (),
                   real_bind_addr->sockaddr_len ());

221
#endif
222 223 224 225 226
#ifdef ZMQ_HAVE_WINDOWS
        wsa_assert (rc != SOCKET_ERROR);
#else
        errno_assert (rc == 0);
#endif
227

228
        if (multicast) {
229
            const ip_addr_t *mcast_addr = udp_addr->target_addr ();
230 231 232 233 234 235

            if (mcast_addr->family () == AF_INET) {
                struct ip_mreq mreq;
                mreq.imr_multiaddr = mcast_addr->ipv4.sin_addr;
                mreq.imr_interface = bind_addr->ipv4.sin_addr;

236 237 238
                rc =
                  setsockopt (fd, IPPROTO_IP, IP_ADD_MEMBERSHIP,
                              reinterpret_cast<char *> (&mreq), sizeof (mreq));
239 240 241 242 243 244 245 246 247 248 249

                errno_assert (rc == 0);
            } else if (mcast_addr->family () == AF_INET6) {
                struct ipv6_mreq mreq;
                int iface = address->resolved.udp_addr->bind_if ();

                zmq_assert (iface >= -1);

                mreq.ipv6mr_multiaddr = mcast_addr->ipv6.sin6_addr;
                mreq.ipv6mr_interface = iface;

250 251 252
                rc =
                  setsockopt (fd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP,
                              reinterpret_cast<char *> (&mreq), sizeof (mreq));
253 254 255 256 257 258 259

                errno_assert (rc == 0);
            } else {
                //  Shouldn't happen
                abort ();
            }

260 261 262 263 264 265 266 267 268 269 270 271 272
#ifdef ZMQ_HAVE_WINDOWS
            wsa_assert (rc != SOCKET_ERROR);
#else
            errno_assert (rc == 0);
#endif
        }
        set_pollin (handle);

        //  Call restart output to drop all join/leave commands
        restart_output ();
    }
}

273
void zmq::udp_engine_t::terminate ()
274 275 276 277 278 279 280 281 282 283 284 285
{
    zmq_assert (plugged);
    plugged = false;

    rm_fd (handle);

    //  Disconnect from I/O threads poller object.
    io_object_t::unplug ();

    delete this;
}

286
void zmq::udp_engine_t::sockaddr_to_msg (zmq::msg_t *msg, sockaddr_in *addr)
287
{
288
    const char *const name = inet_ntoa (addr->sin_addr);
289 290

    char port[6];
291
    sprintf (port, "%d", static_cast<int> (ntohs (addr->sin_port)));
292

293 294 295 296
    const int size = static_cast<int> (strlen (name))
                     + static_cast<int> (strlen (port)) + 1
                     + 1; //  Colon + NULL
    const int rc = msg->init_size (size);
297 298
    errno_assert (rc == 0);
    msg->set_flags (msg_t::more);
299
    char *address = static_cast<char *> (msg->data ());
300 301 302 303 304 305

    strcpy (address, name);
    strcat (address, ":");
    strcat (address, port);
}

306
int zmq::udp_engine_t::resolve_raw_address (char *name_, size_t length_)
307
{
308 309 310 311 312 313
    memset (&raw_address, 0, sizeof raw_address);

    const char *delimiter = NULL;

    // Find delimiter, cannot use memrchr as it is not supported on windows
    if (length_ != 0) {
314
        int chars_left = static_cast<int> (length_);
315 316 317 318 319 320 321 322 323
        char *current_char = name_ + length_;
        do {
            if (*(--current_char) == ':') {
                delimiter = current_char;
                break;
            }
        } while (--chars_left != 0);
    }

324 325 326 327 328 329
    if (!delimiter) {
        errno = EINVAL;
        return -1;
    }

    std::string addr_str (name_, delimiter - name_);
330
    std::string port_str (delimiter + 1, name_ + length_ - delimiter - 1);
331 332

    //  Parse the port number (0 is not a valid port).
333
    uint16_t port = static_cast<uint16_t> (atoi (port_str.c_str ()));
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
    if (port == 0) {
        errno = EINVAL;
        return -1;
    }

    raw_address.sin_family = AF_INET;
    raw_address.sin_port = htons (port);
    raw_address.sin_addr.s_addr = inet_addr (addr_str.c_str ());

    if (raw_address.sin_addr.s_addr == INADDR_NONE) {
        errno = EINVAL;
        return -1;
    }

    return 0;
}

351
void zmq::udp_engine_t::out_event ()
352 353 354 355 356 357 358 359 360 361 362
{
    msg_t group_msg;
    int rc = session->pull_msg (&group_msg);
    errno_assert (rc == 0 || (rc == -1 && errno == EAGAIN));

    if (rc == 0) {
        msg_t body_msg;
        rc = session->pull_msg (&body_msg);

        size_t group_size = group_msg.size ();
        size_t body_size = body_msg.size ();
363
        size_t size;
364

365
        if (options.raw_socket) {
366 367
            rc = resolve_raw_address (static_cast<char *> (group_msg.data ()),
                                      group_size);
368 369 370 371 372 373 374 375 376 377

            //  We discard the message if address is not valid
            if (rc != 0) {
                rc = group_msg.close ();
                errno_assert (rc == 0);

                body_msg.close ();
                errno_assert (rc == 0);

                return;
378
            }
379 380 381

            size = body_size;

382
            memcpy (out_buffer, body_msg.data (), body_size);
383
        } else {
384 385
            size = group_size + body_size + 1;

386
            // TODO: check if larger than maximum size
387
            out_buffer[0] = static_cast<unsigned char> (group_size);
388 389 390
            memcpy (out_buffer + 1, group_msg.data (), group_size);
            memcpy (out_buffer + 1 + group_size, body_msg.data (), body_size);
        }
391 392 393 394 395 396 397

        rc = group_msg.close ();
        errno_assert (rc == 0);

        body_msg.close ();
        errno_assert (rc == 0);

398
#ifdef ZMQ_HAVE_WINDOWS
399 400 401
        rc = sendto (fd, reinterpret_cast<const char *> (out_buffer),
                     static_cast<int> (size), 0, out_address,
                     static_cast<int> (out_addrlen));
402
        wsa_assert (rc != SOCKET_ERROR);
403 404 405 406
#elif defined ZMQ_HAVE_VXWORKS
        rc = sendto (fd, (caddr_t) out_buffer, size, 0,
                     (sockaddr *) out_address, (int) out_addrlen);
        errno_assert (rc != -1);
407
#else
408
        rc = sendto (fd, out_buffer, size, 0, out_address, out_addrlen);
409
        errno_assert (rc != -1);
410
#endif
411 412
    } else
        reset_pollout (handle);
413 414
}

415 416 417 418 419
const char *zmq::udp_engine_t::get_endpoint () const
{
    return "";
}

420
void zmq::udp_engine_t::restart_output ()
421 422 423 424 425 426
{
    //  If we don't support send we just drop all messages
    if (!send_enabled) {
        msg_t msg;
        while (session->pull_msg (&msg) == 0)
            msg.close ();
427 428
    } else {
        set_pollout (handle);
429 430 431 432
        out_event ();
    }
}

433
void zmq::udp_engine_t::in_event ()
434
{
435 436
    sockaddr_storage in_address;
    socklen_t in_addrlen = sizeof (sockaddr_storage);
437
#ifdef ZMQ_HAVE_WINDOWS
438 439 440
    int nbytes =
      recvfrom (fd, reinterpret_cast<char *> (in_buffer), MAX_UDP_MSG, 0,
                reinterpret_cast<sockaddr *> (&in_address), &in_addrlen);
441
    const int last_error = WSAGetLastError ();
442
    if (nbytes == SOCKET_ERROR) {
443 444
        wsa_assert (last_error == WSAENETDOWN || last_error == WSAENETRESET
                    || last_error == WSAEWOULDBLOCK);
445 446
        return;
    }
447 448 449 450 451 452 453 454
#elif defined ZMQ_HAVE_VXWORKS
    int nbytes = recvfrom (fd, (char *) in_buffer, MAX_UDP_MSG, 0,
                           (sockaddr *) &in_address, (int *) &in_addrlen);
    if (nbytes == -1) {
        errno_assert (errno != EBADF && errno != EFAULT && errno != ENOMEM
                      && errno != ENOTSOCK);
        return;
    }
455
#else
456 457
    int nbytes = recvfrom (fd, in_buffer, MAX_UDP_MSG, 0,
                           (sockaddr *) &in_address, &in_addrlen);
458
    if (nbytes == -1) {
459 460
        errno_assert (errno != EBADF && errno != EFAULT && errno != ENOMEM
                      && errno != ENOTSOCK);
461 462 463
        return;
    }
#endif
464
    int rc;
465
    int body_size;
466
    int body_offset;
467
    msg_t msg;
468

469
    if (options.raw_socket) {
470 471
        zmq_assert (in_address.ss_family == AF_INET);
        sockaddr_to_msg (&msg, reinterpret_cast<sockaddr_in *> (&in_address));
472 473 474

        body_size = nbytes;
        body_offset = 0;
475
    } else {
476 477
        const char *group_buffer =
          reinterpret_cast<const char *> (in_buffer) + 1;
478 479 480 481 482 483
        int group_size = in_buffer[0];

        rc = msg.init_size (group_size);
        errno_assert (rc == 0);
        msg.set_flags (msg_t::more);
        memcpy (msg.data (), group_buffer, group_size);
484

485 486 487
        //  This doesn't fit, just ingore
        if (nbytes - 1 < group_size)
            return;
488

489
        body_size = nbytes - 1 - group_size;
490
        body_offset = 1 + group_size;
491
    }
492
    // Push group description to session
493 494
    rc = session->push_msg (&msg);
    errno_assert (rc == 0 || (rc == -1 && errno == EAGAIN));
495

496
    //  Group description message doesn't fit in the pipe, drop
497
    if (rc != 0) {
498 499
        rc = msg.close ();
        errno_assert (rc == 0);
500 501 502

        reset_pollin (handle);
        return;
503
    }
504 505 506 507 508

    rc = msg.close ();
    errno_assert (rc == 0);
    rc = msg.init_size (body_size);
    errno_assert (rc == 0);
509
    memcpy (msg.data (), in_buffer + body_offset, body_size);
510 511

    // Push message body to session
512
    rc = session->push_msg (&msg);
513
    // Message body doesn't fit in the pipe, drop and reset session state
514 515 516 517 518 519 520 521 522
    if (rc != 0) {
        rc = msg.close ();
        errno_assert (rc == 0);

        session->reset ();
        reset_pollin (handle);
        return;
    }

523 524 525
    rc = msg.close ();
    errno_assert (rc == 0);
    session->flush ();
526 527
}

528
void zmq::udp_engine_t::restart_input ()
529 530 531 532 533 534 535
{
    if (!recv_enabled)
        return;

    set_pollin (handle);
    in_event ();
}