v2_decoder.cpp 5.95 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
#include <stdlib.h>
#include <string.h>
33
#include <cmath>
34 35 36 37 38 39 40

#include "v2_protocol.hpp"
#include "v2_decoder.hpp"
#include "likely.hpp"
#include "wire.hpp"
#include "err.hpp"

41 42 43
zmq::v2_decoder_t::v2_decoder_t (size_t bufsize_,
                                 int64_t maxmsgsize_,
                                 bool zero_copy_) :
44
    decoder_base_t<v2_decoder_t, shared_message_memory_allocator> (bufsize_),
45 46 47
    _msg_flags (0),
    _zero_copy (zero_copy_),
    _max_msg_size (maxmsgsize_)
48
{
49
    int rc = _in_progress.init ();
50 51 52
    errno_assert (rc == 0);

    //  At the beginning, read one byte and go to flags_ready state.
53
    next_step (_tmpbuf, 1, &v2_decoder_t::flags_ready);
54 55 56 57
}

zmq::v2_decoder_t::~v2_decoder_t ()
{
58
    int rc = _in_progress.close ();
59 60 61
    errno_assert (rc == 0);
}

62
int zmq::v2_decoder_t::flags_ready (unsigned char const *)
63
{
64 65 66 67 68
    _msg_flags = 0;
    if (_tmpbuf[0] & v2_protocol_t::more_flag)
        _msg_flags |= msg_t::more;
    if (_tmpbuf[0] & v2_protocol_t::command_flag)
        _msg_flags |= msg_t::command;
69 70 71

    //  The payload length is either one or eight bytes,
    //  depending on whether the 'large' bit is set.
72 73
    if (_tmpbuf[0] & v2_protocol_t::large_flag)
        next_step (_tmpbuf, 8, &v2_decoder_t::eight_byte_size_ready);
74
    else
75
        next_step (_tmpbuf, 1, &v2_decoder_t::one_byte_size_ready);
76

77
    return 0;
78 79
}

80
int zmq::v2_decoder_t::one_byte_size_ready (unsigned char const *read_from_)
81
{
82
    return size_ready (_tmpbuf[0], read_from_);
83 84
}

85
int zmq::v2_decoder_t::eight_byte_size_ready (unsigned char const *read_from_)
86
{
87 88
    //  The payload size is encoded as 64-bit unsigned integer.
    //  The most significant byte comes first.
89
    const uint64_t msg_size = get_uint64 (_tmpbuf);
Jens Auer's avatar
Jens Auer committed
90

91
    return size_ready (msg_size, read_from_);
Jens Auer's avatar
Jens Auer committed
92
}
93

94 95
int zmq::v2_decoder_t::size_ready (uint64_t msg_size_,
                                   unsigned char const *read_pos_)
96
{
97
    //  Message size must not exceed the maximum allowed size.
98 99
    if (_max_msg_size >= 0)
        if (unlikely (msg_size_ > static_cast<uint64_t> (_max_msg_size))) {
100 101 102
            errno = EMSGSIZE;
            return -1;
        }
103 104

    //  Message size must fit into size_t data type.
105
    if (unlikely (msg_size_ != static_cast<size_t> (msg_size_))) {
106 107 108
        errno = EMSGSIZE;
        return -1;
    }
109

110
    int rc = _in_progress.close ();
111
    assert (rc == 0);
Jens Auer's avatar
Jens Auer committed
112 113 114

    // the current message can exceed the current buffer. We have to copy the buffer
    // data into a new message and complete it in the next receive.
115

116
    shared_message_memory_allocator &allocator = get_allocator ();
117
    if (unlikely (!_zero_copy
118
                  || ((unsigned char *) read_pos_ + msg_size_
119
                      > (allocator.data () + allocator.size ())))) {
Jens Auer's avatar
Jens Auer committed
120
        // a new message has started, but the size would exceed the pre-allocated arena
121
        // this happens every time when a message does not fit completely into the buffer
122
        rc = _in_progress.init_size (static_cast<size_t> (msg_size_));
123
    } else {
Jens Auer's avatar
Jens Auer committed
124 125
        // construct message using n bytes from the buffer as storage
        // increase buffer ref count
126
        // if the message will be a large message, pass a valid refcnt memory location as well
127
        rc =
128 129 130 131
          _in_progress.init (const_cast<unsigned char *> (read_pos_),
                             static_cast<size_t> (msg_size_),
                             shared_message_memory_allocator::call_dec_ref,
                             allocator.buffer (), allocator.provide_content ());
Jens Auer's avatar
Jens Auer committed
132 133

        // For small messages, data has been copied and refcount does not have to be increased
134
        if (_in_progress.is_zcmsg ()) {
135 136
            allocator.advance_content ();
            allocator.inc_ref ();
Jens Auer's avatar
Jens Auer committed
137 138 139
        }
    }

140 141
    if (unlikely (rc)) {
        errno_assert (errno == ENOMEM);
142
        rc = _in_progress.init ();
143
        errno_assert (rc == 0);
144 145
        errno = ENOMEM;
        return -1;
146 147
    }

148
    _in_progress.set_flags (_msg_flags);
Jens Auer's avatar
Jens Auer committed
149 150 151 152 153 154
    // this sets read_pos to
    // the message data address if the data needs to be copied
    // for small message / messages exceeding the current buffer
    // or
    // to the current start address in the buffer because the message
    // was constructed to use n bytes from the address passed as argument
155
    next_step (_in_progress.data (), _in_progress.size (),
156
               &v2_decoder_t::message_ready);
157

158
    return 0;
159 160
}

161
int zmq::v2_decoder_t::message_ready (unsigned char const *)
162
{
163 164
    //  Message is completely read. Signal this to the caller
    //  and prepare to decode next message.
165
    next_step (_tmpbuf, 1, &v2_decoder_t::flags_ready);
166
    return 1;
167
}