ipc_connecter.cpp 7.42 KB
Newer Older
1
/*
2
    Copyright (c) 2007-2015 Contributors as noted in the AUTHORS file
3

4
    This file is part of libzmq, the ZeroMQ core engine in C++.
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
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.
25 26 27 28 29

    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/>.
*/

30 31 32 33
#include "ipc_connecter.hpp"

#if !defined ZMQ_HAVE_WINDOWS && !defined ZMQ_HAVE_OPENVMS

34 35 36
#include <new>
#include <string>

37
#include "stream_engine.hpp"
38 39 40 41
#include "io_thread.hpp"
#include "platform.hpp"
#include "random.hpp"
#include "err.hpp"
42
#include "ip.hpp"
43 44
#include "address.hpp"
#include "ipc_address.hpp"
45
#include "session_base.hpp"
46 47 48 49

#include <unistd.h>
#include <sys/types.h>
#include <sys/socket.h>
50
#include <sys/un.h>
51 52

zmq::ipc_connecter_t::ipc_connecter_t (class io_thread_t *io_thread_,
53
      class session_base_t *session_, const options_t &options_,
54
      const address_t *addr_, bool delayed_start_) :
55 56
    own_t (io_thread_, options_),
    io_object_t (io_thread_),
57
    addr (addr_),
58 59
    s (retired_fd),
    handle_valid (false),
60 61
    delayed_start (delayed_start_),
    timer_started (false),
62 63 64
    session (session_),
    current_reconnect_ivl(options.reconnect_ivl)
{
65 66
    zmq_assert (addr);
    zmq_assert (addr->protocol == "ipc");
67
    addr->to_string (endpoint);
68
    socket = session-> get_socket();
69 70 71 72
}

zmq::ipc_connecter_t::~ipc_connecter_t ()
{
73
    zmq_assert (!timer_started);
74 75
    zmq_assert (!handle_valid);
    zmq_assert (s == retired_fd);
76 77 78 79
}

void zmq::ipc_connecter_t::process_plug ()
{
80 81
    if (delayed_start)
        add_reconnect_timer ();
82 83 84 85
    else
        start_connecting ();
}

86 87
void zmq::ipc_connecter_t::process_term (int linger_)
{
88
    if (timer_started) {
89
        cancel_timer (reconnect_timer_id);
90
        timer_started = false;
91 92 93 94 95 96 97 98 99 100 101 102 103
    }

    if (handle_valid) {
        rm_fd (handle);
        handle_valid = false;
    }

    if (s != retired_fd)
        close ();

    own_t::process_term (linger_);
}

104 105
void zmq::ipc_connecter_t::in_event ()
{
106
    //  We are not polling for incoming data, so we are actually called
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
    //  because of error here. However, we can get error on out event as well
    //  on some platforms, so we'll simply handle both events in the same way.
    out_event ();
}

void zmq::ipc_connecter_t::out_event ()
{
    fd_t fd = connect ();
    rm_fd (handle);
    handle_valid = false;

    //  Handle the error condition by attempt to reconnect.
    if (fd == retired_fd) {
        close ();
        add_reconnect_timer();
        return;
    }
    //  Create the engine object for this connection.
125
    stream_engine_t *engine = new (std::nothrow)
126
        stream_engine_t (fd, options, endpoint);
127 128 129 130 131 132 133
    alloc_assert (engine);

    //  Attach the engine to the corresponding session object.
    send_attach (session, engine);

    //  Shut the connecter down.
    terminate ();
134

135
    socket->event_connected (endpoint, fd);
136 137 138 139 140
}

void zmq::ipc_connecter_t::timer_event (int id_)
{
    zmq_assert (id_ == reconnect_timer_id);
141
    timer_started = false;
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
    start_connecting ();
}

void zmq::ipc_connecter_t::start_connecting ()
{
    //  Open the connecting socket.
    int rc = open ();

    //  Connect may succeed in synchronous manner.
    if (rc == 0) {
        handle = add_fd (s);
        handle_valid = true;
        out_event ();
    }

157
    //  Connection establishment may be delayed. Poll for its completion.
158 159
    else
    if (rc == -1 && errno == EINPROGRESS) {
160 161 162
        handle = add_fd (s);
        handle_valid = true;
        set_pollout (handle);
163
        socket->event_connect_delayed (endpoint, zmq_errno());
164 165 166
    }

    //  Handle any other error condition by eventual reconnect.
167
    else {
168 169
        if (s != retired_fd)
            close ();
170 171
        add_reconnect_timer ();
    }
172 173 174 175
}

void zmq::ipc_connecter_t::add_reconnect_timer()
{
176 177
    int rc_ivl = get_new_reconnect_ivl();
    add_timer (rc_ivl, reconnect_timer_id);
178
    socket->event_connect_retried (endpoint, rc_ivl);
179
    timer_started = true;
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
}

int zmq::ipc_connecter_t::get_new_reconnect_ivl ()
{
    //  The new interval is the current interval + random value.
    int this_interval = current_reconnect_ivl +
        (generate_random () % options.reconnect_ivl);

    //  Only change the current reconnect interval  if the maximum reconnect
    //  interval was set and if it's larger than the reconnect interval.
    if (options.reconnect_ivl_max > 0 && 
        options.reconnect_ivl_max > options.reconnect_ivl) {

        //  Calculate the next interval
        current_reconnect_ivl = current_reconnect_ivl * 2;
        if(current_reconnect_ivl >= options.reconnect_ivl_max) {
            current_reconnect_ivl = options.reconnect_ivl_max;
        }   
    }
    return this_interval;
}

int zmq::ipc_connecter_t::open ()
{
    zmq_assert (s == retired_fd);

    //  Create the socket.
207
    s = open_socket (AF_UNIX, SOCK_STREAM, 0);
208
    if (s == -1)
209 210
        return -1;

211 212
    //  Set the non-blocking flag.
    unblock_socket (s);
213 214

    //  Connect to the remote peer.
215 216 217
    int rc = ::connect (
        s, addr->resolved.ipc_addr->addr (),
        addr->resolved.ipc_addr->addrlen ());
218

219
    //  Connect was successful immediately.
220 221
    if (rc == 0)
        return 0;
222 223 224 225 226 227 228
        
    //  Translate other error codes indicating asynchronous connect has been
    //  launched to a uniform EINPROGRESS.
    if (rc == -1 && errno == EINTR) {
        errno = EINPROGRESS;
        return -1;
    }
229

230
    //  Forward the error.
231 232 233 234 235 236 237
    return -1;
}

int zmq::ipc_connecter_t::close ()
{
    zmq_assert (s != retired_fd);
    int rc = ::close (s);
238
    errno_assert (rc == 0);
239
    socket->event_closed (endpoint, s);
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
    s = retired_fd;
    return 0;
}

zmq::fd_t zmq::ipc_connecter_t::connect ()
{
    //  Following code should handle both Berkeley-derived socket
    //  implementations and Solaris.
    int err = 0;
#if defined ZMQ_HAVE_HPUX
    int len = sizeof (err);
#else
    socklen_t len = sizeof (err);
#endif
    int rc = getsockopt (s, SOL_SOCKET, SO_ERROR, (char*) &err, &len);
    if (rc == -1)
        err = errno;
    if (err != 0) {

        //  Assert if the error was caused by 0MQ bug.
        //  Networking problems are OK. No need to assert.
        errno = err;
        errno_assert (errno == ECONNREFUSED || errno == ECONNRESET ||
            errno == ETIMEDOUT || errno == EHOSTUNREACH ||
            errno == ENETUNREACH || errno == ENETDOWN);

        return retired_fd;
    }

    fd_t result = s;
    s = retired_fd;
    return result;
}

#endif
275