dist.cpp 6.36 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 32 33
#include "dist.hpp"
#include "pipe.hpp"
#include "err.hpp"
34
#include "msg.hpp"
35
#include "likely.hpp"
36

37
zmq::dist_t::dist_t () :
38
    matching (0),
39
    active (0),
40
    eligible (0),
41
    more (false)
42 43 44 45 46 47 48 49
{
}

zmq::dist_t::~dist_t ()
{
    zmq_assert (pipes.empty ());
}

50
void zmq::dist_t::attach (pipe_t *pipe_)
51
{
52 53 54 55 56 57 58 59 60 61 62 63 64 65
    //  If we are in the middle of sending a message, we'll add new pipe
    //  into the list of eligible pipes. Otherwise we add it to the list
    //  of active pipes.
    if (more) {
        pipes.push_back (pipe_);
        pipes.swap (eligible, pipes.size () - 1);
        eligible++;
    }
    else {
        pipes.push_back (pipe_);
        pipes.swap (active, pipes.size () - 1);
        active++;
        eligible++;
    }
66 67
}

68 69 70 71 72 73 74 75 76 77 78 79
void zmq::dist_t::match (pipe_t *pipe_)
{
    //  If pipe is already matching do nothing.
    if (pipes.index (pipe_) < matching)
        return;

    //  If the pipe isn't eligible, ignore it.
    if (pipes.index (pipe_) >= eligible)
        return;

    //  Mark the pipe as matching.
    pipes.swap (pipes.index (pipe_), matching);
80
    matching++;
81 82
}

83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
void zmq::dist_t::reverse_match ()
{
    pipes_t::size_type prev_matching = matching;

    // Reset matching to 0
    unmatch();

    // Mark all matching pipes as not matching and vice-versa.
    // To do this, push all pipes that are eligible but not
    // matched - i.e. between "matching" and "eligible" -
    // to the beginning of the queue.
    for (pipes_t::size_type i = prev_matching; i < eligible; ++i) {
        pipes.swap(i, matching++);
    }
}

99 100 101 102 103
void zmq::dist_t::unmatch ()
{
    matching = 0;
}

104
void zmq::dist_t::pipe_terminated (pipe_t *pipe_)
105
{
106
    //  Remove the pipe from the list; adjust number of matching, active and/or
107
    //  eligible pipes accordingly.
ganesh.vr's avatar
ganesh.vr committed
108 109
    if (pipes.index (pipe_) < matching) {
        pipes.swap (pipes.index (pipe_), matching - 1);
110
        matching--;
ganesh.vr's avatar
ganesh.vr committed
111 112 113
    }
    if (pipes.index (pipe_) < active) {
        pipes.swap (pipes.index (pipe_), active - 1);
114
        active--;
ganesh.vr's avatar
ganesh.vr committed
115 116 117
    }
    if (pipes.index (pipe_) < eligible) {
        pipes.swap (pipes.index (pipe_), eligible - 1);
118
        eligible--;
ganesh.vr's avatar
ganesh.vr committed
119 120
    }

121 122 123
    pipes.erase (pipe_);
}

124
void zmq::dist_t::activated (pipe_t *pipe_)
125
{
126
    //  Move the pipe from passive to eligible state.
127 128 129 130
    if (eligible < pipes.size ()) {
        pipes.swap (pipes.index (pipe_), eligible);
        eligible++;
    }
131 132 133

    //  If there's no message being sent at the moment, move it to
    //  the active state.
134
    if (!more && active < pipes.size ()) {
135
        pipes.swap (eligible - 1, active);
136 137
        active++;
    }
138 139
}

140
int zmq::dist_t::send_to_all (msg_t *msg_)
141 142
{
    matching = active;
143
    return send_to_matching (msg_);
144 145
}

146
int zmq::dist_t::send_to_matching (msg_t *msg_)
147 148
{
    //  Is this end of a multipart message?
149
    bool msg_more = msg_->flags () & msg_t::more ? true : false;
150

151
    //  Push the message to matching pipes.
152
    distribute (msg_);
153

154
    //  If multipart message is fully sent, activate all the eligible pipes.
155 156
    if (!msg_more)
        active = eligible;
157 158 159 160 161 162

    more = msg_more;

    return 0;
}

163
void zmq::dist_t::distribute (msg_t *msg_)
164
{
165 166
    //  If there are no matching pipes available, simply drop the message.
    if (matching == 0) {
167 168 169
        int rc = msg_->close ();
        errno_assert (rc == 0);
        rc = msg_->init ();
170
        errno_assert (rc == 0);
171
        return;
172 173
    }

174 175
    if (msg_->is_vsm ()) {
        for (pipes_t::size_type i = 0; i < matching; ++i)
Douglas Young's avatar
Douglas Young committed
176 177
            if(!write (pipes [i], msg_))
                --i; //  Retry last write because index will have been swapped
178 179 180 181 182 183 184
        int rc = msg_->close();
        errno_assert (rc == 0);
        rc = msg_->init ();
        errno_assert (rc == 0);
        return;
    }

185
    //  Add matching-1 references to the message. We already hold one reference,
186
    //  that's why -1.
Martin Sustrik's avatar
Martin Sustrik committed
187
    msg_->add_refs ((int) matching - 1);
188

189
    //  Push copy of the message to each matching pipe.
190 191
    int failed = 0;
    for (pipes_t::size_type i = 0; i < matching; ++i)
Douglas Young's avatar
Douglas Young committed
192
        if (!write (pipes [i], msg_)) {
193
            ++failed;
Douglas Young's avatar
Douglas Young committed
194 195
            --i; //  Retry last write because index will have been swapped
        }
196 197
    if (unlikely (failed))
        msg_->rm_refs (failed);
198

199 200 201 202
    //  Detach the original message from the data buffer. Note that we don't
    //  close the message. That's because we've already used all the references.
    int rc = msg_->init ();
    errno_assert (rc == 0);
203 204 205 206 207 208 209
}

bool zmq::dist_t::has_out ()
{
    return true;
}

210
bool zmq::dist_t::write (pipe_t *pipe_, msg_t *msg_)
211 212
{
    if (!pipe_->write (msg_)) {
213 214
        pipes.swap (pipes.index (pipe_), matching - 1);
        matching--;
215
        pipes.swap (pipes.index (pipe_), active - 1);
216
        active--;
217 218
        pipes.swap (active, eligible - 1);
        eligible--;
219 220
        return false;
    }
221
    if (!(msg_->flags () & msg_t::more))
222 223 224 225
        pipe_->flush ();
    return true;
}

226 227
bool zmq::dist_t::check_hwm ()
{
Martin Hurton's avatar
Martin Hurton committed
228 229 230
    for (pipes_t::size_type i = 0; i < matching; ++i)
        if (!pipes [i]->check_hwm ())
            return false;
231

Martin Hurton's avatar
Martin Hurton committed
232
    return true;
233 234 235
}