stream.cpp 9.4 KB
Newer Older
1
/*
2
    Copyright (c) 2007-2016 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
#include "precompiled.hpp"
31
#include "macros.hpp"
32 33 34 35 36 37 38 39 40 41
#include "stream.hpp"
#include "pipe.hpp"
#include "wire.hpp"
#include "random.hpp"
#include "likely.hpp"
#include "err.hpp"

zmq::stream_t::stream_t (class ctx_t *parent_, uint32_t tid_, int sid_) :
    socket_base_t (parent_, tid_, sid_),
    prefetched (false),
42
    routing_id_sent (false),
43 44
    current_out (NULL),
    more_out (false),
45
    next_integral_routing_id (generate_random ())
46 47
{
    options.type = ZMQ_STREAM;
48
    options.raw_socket = true;
49

50
    prefetched_routing_id.init ();
51 52 53 54 55 56
    prefetched_msg.init ();
}

zmq::stream_t::~stream_t ()
{
    zmq_assert (outpipes.empty ());
57
    prefetched_routing_id.close ();
58 59 60
    prefetched_msg.close ();
}

61
void zmq::stream_t::xattach_pipe (pipe_t *pipe_, bool subscribe_to_all_)
62
{
63
    LIBZMQ_UNUSED(subscribe_to_all_);
64 65 66

    zmq_assert (pipe_);

67 68
    identify_peer (pipe_);
    fq.attach (pipe_);
69 70 71 72
}

void zmq::stream_t::xpipe_terminated (pipe_t *pipe_)
{
73
    outpipes_t::iterator it = outpipes.find (pipe_->get_routing_id ());
74 75 76 77 78
    zmq_assert (it != outpipes.end ());
    outpipes.erase (it);
    fq.pipe_terminated (pipe_);
    if (pipe_ == current_out)
        current_out = NULL;
79 80 81 82
}

void zmq::stream_t::xread_activated (pipe_t *pipe_)
{
83
    fq.activated (pipe_);
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
}

void zmq::stream_t::xwrite_activated (pipe_t *pipe_)
{
    outpipes_t::iterator it;
    for (it = outpipes.begin (); it != outpipes.end (); ++it)
        if (it->second.pipe == pipe_)
            break;

    zmq_assert (it != outpipes.end ());
    zmq_assert (!it->second.active);
    it->second.active = true;
}

int zmq::stream_t::xsend (msg_t *msg_)
{
    //  If this is the first part of the message it's the ID of the
    //  peer to send the message to.
    if (!more_out) {
        zmq_assert (!current_out);

        //  If we have malformed message (prefix with no subsequent message)
        //  then just silently ignore it.
        //  TODO: The connections should be killed instead.
        if (msg_->flags () & msg_t::more) {

110
            //  Find the pipe associated with the routing id stored in the prefix.
111
            //  If there's no such pipe return an error
112 113
            blob_t routing_id ((unsigned char*) msg_->data (), msg_->size ());
            outpipes_t::iterator it = outpipes.find (routing_id);
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129

            if (it != outpipes.end ()) {
                current_out = it->second.pipe;
                if (!current_out->check_write ()) {
                    it->second.active = false;
                    current_out = NULL;
                    errno = EAGAIN;
                    return -1;
                }
            }
            else {
                errno = EHOSTUNREACH;
                return -1;
            }
        }

130 131 132
        //  Expect one more message frame.
        more_out = true;

133 134 135 136 137 138 139
        int rc = msg_->close ();
        errno_assert (rc == 0);
        rc = msg_->init ();
        errno_assert (rc == 0);
        return 0;
    }

140
    //  Ignore the MORE flag
141 142
    msg_->reset_flags (msg_t::more);

143 144
    //  This is the last part of the message.
    more_out = false;
145 146 147 148 149 150 151

    //  Push the message into the pipe. If there's no out pipe, just drop it.
    if (current_out) {

        // Close the remote connection if user has asked to do so
        // by sending zero length message.
        // Pending messages in the pipe will be dropped (on receiving term- ack)
152
        if (msg_->size () == 0) {
153 154 155
            current_out->terminate (false);
            int rc = msg_->close ();
            errno_assert (rc == 0);
156 157
            rc = msg_->init ();
            errno_assert (rc == 0);
158 159 160 161
            current_out = NULL;
            return 0;
        }
        bool ok = current_out->write (msg_);
162
        if (likely (ok))
163
            current_out->flush ();
164
        current_out = NULL;
165 166 167 168 169 170 171 172 173 174 175 176
    }
    else {
        int rc = msg_->close ();
        errno_assert (rc == 0);
    }

    //  Detach the message from the data buffer.
    int rc = msg_->init ();
    errno_assert (rc == 0);

    return 0;
}
177

178 179 180
int zmq::stream_t::xsetsockopt (int option_, const void *optval_,
    size_t optvallen_)
{
181
    bool is_int = (optvallen_ == sizeof (int));
182 183
    int value = 0;
    if (is_int) memcpy(&value, optval_, sizeof (int));
184

185
    switch (option_) {
186
        case ZMQ_CONNECT_ROUTING_ID:
187
            if (optval_ && optvallen_) {
188
                connect_routing_id.assign ((char*) optval_, optvallen_);
189 190 191
                return 0;
            }
            break;
192

193 194
        case ZMQ_STREAM_NOTIFY:
            if (is_int && (value == 0 || value == 1)) {
evoskuil's avatar
evoskuil committed
195
                options.raw_notify = (value != 0);
196 197 198 199
                return 0;
            }
            break;

200 201 202 203 204 205
        default:
            break;
    }
    errno = EINVAL;
    return -1;
}
206

207 208 209
int zmq::stream_t::xrecv (msg_t *msg_)
{
    if (prefetched) {
210 211
        if (!routing_id_sent) {
            int rc = msg_->move (prefetched_routing_id);
212
            errno_assert (rc == 0);
213
            routing_id_sent = true;
214 215 216 217 218 219 220 221 222 223
        }
        else {
            int rc = msg_->move (prefetched_msg);
            errno_assert (rc == 0);
            prefetched = false;
        }
        return 0;
    }

    pipe_t *pipe = NULL;
224
    int rc = fq.recvpipe (&prefetched_msg, &pipe);
225 226 227 228
    if (rc != 0)
        return -1;

    zmq_assert (pipe != NULL);
229
    zmq_assert ((prefetched_msg.flags () & msg_t::more) == 0);
230

231
    //  We have received a frame with TCP data.
232
    //  Rather than sending this frame, we keep it in prefetched
233
    //  buffer and send a frame with peer's ID.
234
    const blob_t &routing_id = pipe->get_routing_id ();
235 236
    rc = msg_->close();
    errno_assert (rc == 0);
237
    rc = msg_->init_size (routing_id.size ());
238
    errno_assert (rc == 0);
239 240 241 242 243 244

    // forward metadata (if any)
    metadata_t *metadata = prefetched_msg.metadata();
    if (metadata)
        msg_->set_metadata(metadata);

245
    memcpy (msg_->data (), routing_id.data (), routing_id.size ());
246
    msg_->set_flags (msg_t::more);
247

248
    prefetched = true;
249
    routing_id_sent = true;
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267

    return 0;
}

bool zmq::stream_t::xhas_in ()
{
    //  We may already have a message pre-fetched.
    if (prefetched)
        return true;

    //  Try to read the next message.
    //  The message, if read, is kept in the pre-fetch buffer.
    pipe_t *pipe = NULL;
    int rc = fq.recvpipe (&prefetched_msg, &pipe);
    if (rc != 0)
        return false;

    zmq_assert (pipe != NULL);
268
    zmq_assert ((prefetched_msg.flags () & msg_t::more) == 0);
269

270
    const blob_t &routing_id = pipe->get_routing_id ();
271
    rc = prefetched_routing_id.init_size (routing_id.size ());
272
    errno_assert (rc == 0);
273 274 275 276

    // forward metadata (if any)
    metadata_t *metadata = prefetched_msg.metadata();
    if (metadata)
277
        prefetched_routing_id.set_metadata(metadata);
278

279 280
    memcpy (prefetched_routing_id.data (), routing_id.data (), routing_id.size ());
    prefetched_routing_id.set_flags (msg_t::more);
281 282

    prefetched = true;
283
    routing_id_sent = false;
284 285 286 287 288 289

    return true;
}

bool zmq::stream_t::xhas_out ()
{
290
    //  In theory, STREAM socket is always ready for writing. Whether actual
291 292 293 294 295
    //  attempt to write succeeds depends on which pipe the message is going
    //  to be routed to.
    return true;
}

296
void zmq::stream_t::identify_peer (pipe_t *pipe_)
297
{
298
    //  Always assign routing id for raw-socket
299 300
    unsigned char buffer [5];
    buffer [0] = 0;
301
    blob_t routing_id;
302
    if (connect_routing_id.length ()) {
303
        routing_id.set ((unsigned char*) connect_routing_id.c_str(),
304 305
            connect_routing_id.length ());
        connect_routing_id.clear ();
306
        outpipes_t::iterator it = outpipes.find (routing_id);
307
        zmq_assert (it == outpipes.end ());
308
    }
309
    else {
310
        put_uint32 (buffer + 1, next_integral_routing_id++);
311
        routing_id.set (buffer, sizeof buffer);
312 313
        memcpy (options.routing_id, routing_id.data (), routing_id.size ());
        options.routing_id_size = (unsigned char) routing_id.size ();
314
    }
315
    pipe_->set_router_socket_routing_id (routing_id);
316 317
    //  Add the record into output pipes lookup table
    outpipe_t outpipe = {pipe_, true};
318 319
    const bool ok = outpipes.ZMQ_MAP_INSERT_OR_EMPLACE (
        ZMQ_MOVE(routing_id), outpipe).second;
320 321
    zmq_assert (ok);
}