proxy.cpp 6.55 KB
Newer Older
Pieter Hintjens's avatar
Pieter Hintjens committed
1
/*
2
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
Pieter Hintjens's avatar
Pieter Hintjens committed
3

4
    This file is part of libzmq, the ZeroMQ core engine in C++.
Pieter Hintjens's avatar
Pieter Hintjens committed
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
Pieter Hintjens's avatar
Pieter Hintjens committed
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.
Pieter Hintjens's avatar
Pieter Hintjens committed
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"
Pieter Hintjens's avatar
Pieter Hintjens committed
31
#include <stddef.h>
32
#include "poller.hpp"
33
#include "proxy.hpp"
Pieter Hintjens's avatar
Pieter Hintjens committed
34 35
#include "likely.hpp"

Pieter Hintjens's avatar
Pieter Hintjens committed
36 37 38 39
//  On AIX platform, poll.h has to be included first to get consistent
//  definition of pollfd structure (AIX uses 'reqevents' and 'retnevents'
//  instead of 'events' and 'revents' and defines macros to map from POSIX-y
//  names to AIX-specific names).
40
#if defined ZMQ_POLL_BASED_ON_POLL && !defined ZMQ_HAVE_WINDOWS
Pieter Hintjens's avatar
Pieter Hintjens committed
41 42 43
#include <poll.h>
#endif

44 45 46 47 48
// These headers end up pulling in zmq.h somewhere in their include
// dependency chain
#include "socket_base.hpp"
#include "err.hpp"

49
// TODO: determine if this is an issue, since zmq.h is being loaded from pch.
Pieter Hintjens's avatar
Pieter Hintjens committed
50
// zmq.h must be included *after* poll.h for AIX to build properly
51
//#include "../include/zmq.h"
Pieter Hintjens's avatar
Pieter Hintjens committed
52

53
int capture(
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
        class zmq::socket_base_t *capture_,
        zmq::msg_t& msg_,
        int more_ = 0)
{
    //  Copy message to capture socket if any
    if (capture_) {
        zmq::msg_t ctrl;
        int rc = ctrl.init ();
        if (unlikely (rc < 0))
            return -1;
        rc = ctrl.copy (msg_);
        if (unlikely (rc < 0))
            return -1;
        rc = capture_->send (&ctrl, more_? ZMQ_SNDMORE: 0);
        if (unlikely (rc < 0))
            return -1;
    }
    return 0;
}

74
int forward(
75 76 77
        class zmq::socket_base_t *from_,
        class zmq::socket_base_t *to_,
        class zmq::socket_base_t *capture_,
78
        zmq::msg_t& msg_)
79 80 81
{
    int more;
    size_t moresz;
82
    while (true) {
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
        int rc = from_->recv (&msg_, 0);
        if (unlikely (rc < 0))
            return -1;

        moresz = sizeof more;
        rc = from_->getsockopt (ZMQ_RCVMORE, &more, &moresz);
        if (unlikely (rc < 0))
            return -1;

        //  Copy message to capture socket if any
        rc = capture(capture_, msg_, more);
        if (unlikely (rc < 0))
            return -1;

        rc = to_->send (&msg_, more? ZMQ_SNDMORE: 0);
        if (unlikely (rc < 0))
            return -1;
        if (more == 0)
            break;
    }
    return 0;
}
Pieter Hintjens's avatar
Pieter Hintjens committed
105

106
int zmq::proxy (
107 108 109
    class socket_base_t *frontend_,
    class socket_base_t *backend_,
    class socket_base_t *capture_,
110
    class socket_base_t *control_)
Pieter Hintjens's avatar
Pieter Hintjens committed
111 112 113
{
    msg_t msg;
    int rc = msg.init ();
Pieter Hintjens's avatar
Pieter Hintjens committed
114
    if (rc != 0)
Pieter Hintjens's avatar
Pieter Hintjens committed
115 116
        return -1;

117
    //  The algorithm below assumes ratio of requests and replies processed
Pieter Hintjens's avatar
Pieter Hintjens committed
118
    //  under full load to be 1:1.
119

Pieter Hintjens's avatar
Pieter Hintjens committed
120
    int more;
Pieter Hintjens's avatar
Pieter Hintjens committed
121
    size_t moresz;
122
    zmq_pollitem_t items [] = {
123 124
        { frontend_, 0, ZMQ_POLLIN, 0 },
        { backend_, 0, ZMQ_POLLIN, 0 },
125 126 127
        { control_, 0, ZMQ_POLLIN, 0 }
    };
    int qt_poll_items = (control_ ? 3 : 2);
128 129 130 131
    zmq_pollitem_t itemsout [] = {
        { frontend_, 0, ZMQ_POLLOUT, 0 },
        { backend_, 0, ZMQ_POLLOUT, 0 }
    };
Pieter Hintjens's avatar
Pieter Hintjens committed
132 133 134 135 136 137 138 139 140

    //  Proxy can be in these three states
    enum {
        active,
        paused,
        terminated
    } state = active;

    while (state != terminated) {
Pieter Hintjens's avatar
Pieter Hintjens committed
141
        //  Wait while there are either requests or replies to process.
142
        rc = zmq_poll (&items [0], qt_poll_items, -1);
Pieter Hintjens's avatar
Pieter Hintjens committed
143
        if (unlikely (rc < 0))
Pieter Hintjens's avatar
Pieter Hintjens committed
144 145
            return -1;

146
        //  Get the pollout separately because when combining this with pollin it maxes the CPU
147 148 149 150 151 152 153 154
        //  because pollout shall most of the time return directly.
        //  POLLOUT is only checked when frontend and backend sockets are not the same.
        if (frontend_ != backend_) {
            rc = zmq_poll (&itemsout [0], 2, 0);
            if (unlikely (rc < 0)) {
                return -1;
            }
        }
155

156
        //  Process a control command if any
157
        if (control_ && items [2].revents & ZMQ_POLLIN) {
Pieter Hintjens's avatar
Pieter Hintjens committed
158 159 160 161 162 163 164 165 166 167
            rc = control_->recv (&msg, 0);
            if (unlikely (rc < 0))
                return -1;

            moresz = sizeof more;
            rc = control_->getsockopt (ZMQ_RCVMORE, &more, &moresz);
            if (unlikely (rc < 0) || more)
                return -1;

            //  Copy message to capture socket if any
168 169 170 171
            rc = capture(capture_, msg);
            if (unlikely (rc < 0))
                return -1;

172
            if (msg.size () == 5 && memcmp (msg.data (), "PAUSE", 5) == 0)
Pieter Hintjens's avatar
Pieter Hintjens committed
173 174
                state = paused;
            else
175
            if (msg.size () == 6 && memcmp (msg.data (), "RESUME", 6) == 0)
Pieter Hintjens's avatar
Pieter Hintjens committed
176 177
                state = active;
            else
178
            if (msg.size () == 9 && memcmp (msg.data (), "TERMINATE", 9) == 0)
Pieter Hintjens's avatar
Pieter Hintjens committed
179 180 181 182
                state = terminated;
            else {
                //  This is an API error, we should assert
                puts ("E: invalid command sent to proxy");
183
                zmq_assert (false);
Pieter Hintjens's avatar
Pieter Hintjens committed
184
            }
185
        }
186 187
        //  Process a request
        if (state == active
188
        &&  items [0].revents & ZMQ_POLLIN
189
        &&  (frontend_ == backend_ || itemsout [1].revents & ZMQ_POLLOUT)) {
190
            rc = forward(frontend_, backend_, capture_,msg);
191 192 193 194 195
            if (unlikely (rc < 0))
                return -1;
        }
        //  Process a reply
        if (state == active
196
        &&  frontend_ != backend_
197
        &&  items [1].revents & ZMQ_POLLIN
198
        &&  itemsout [0].revents & ZMQ_POLLOUT) {
199
            rc = forward(backend_, frontend_, capture_,msg);
200 201
            if (unlikely (rc < 0))
                return -1;
Pieter Hintjens's avatar
Pieter Hintjens committed
202 203 204 205
        }
    }
    return 0;
}