mirror of
https://github.com/zeromq/libzmq.git
synced 2025-03-18 17:36:57 +00:00
253e9dd27b
Solution: if all peers of a socket are >= 3.1 use sub/cancel commands instead of the old 0/1 messages. For backward compatibility, move the handling of 0/1 or sub/cancel command strings to the encoders, so that the right thing can be done depending on the protocol version. Do not set the command flag until the encoder, so that we can handle the inproc case (which skips the encoder).
674 lines
17 KiB
C++
674 lines
17 KiB
C++
/*
|
|
Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
|
|
|
|
This file is part of libzmq, the ZeroMQ core engine in C++.
|
|
|
|
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
|
|
(at your option) any later version.
|
|
|
|
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.
|
|
|
|
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/>.
|
|
*/
|
|
|
|
#include "precompiled.hpp"
|
|
#include "macros.hpp"
|
|
#include "msg.hpp"
|
|
|
|
#include <string.h>
|
|
#include <stdlib.h>
|
|
#include <new>
|
|
|
|
#include "stdint.hpp"
|
|
#include "likely.hpp"
|
|
#include "metadata.hpp"
|
|
#include "err.hpp"
|
|
|
|
// Check whether the sizes of public representation of the message (zmq_msg_t)
|
|
// and private representation of the message (zmq::msg_t) match.
|
|
|
|
typedef char
|
|
zmq_msg_size_check[2 * ((sizeof (zmq::msg_t) == sizeof (zmq_msg_t)) != 0)
|
|
- 1];
|
|
|
|
bool zmq::msg_t::check () const
|
|
{
|
|
return _u.base.type >= type_min && _u.base.type <= type_max;
|
|
}
|
|
|
|
int zmq::msg_t::init (void *data_,
|
|
size_t size_,
|
|
msg_free_fn *ffn_,
|
|
void *hint_,
|
|
content_t *content_)
|
|
{
|
|
if (size_ < max_vsm_size) {
|
|
const int rc = init_size (size_);
|
|
|
|
if (rc != -1) {
|
|
memcpy (data (), data_, size_);
|
|
return 0;
|
|
}
|
|
return -1;
|
|
}
|
|
if (content_) {
|
|
return init_external_storage (content_, data_, size_, ffn_, hint_);
|
|
}
|
|
return init_data (data_, size_, ffn_, hint_);
|
|
}
|
|
|
|
int zmq::msg_t::init ()
|
|
{
|
|
_u.vsm.metadata = NULL;
|
|
_u.vsm.type = type_vsm;
|
|
_u.vsm.flags = 0;
|
|
_u.vsm.size = 0;
|
|
_u.vsm.group[0] = '\0';
|
|
_u.vsm.routing_id = 0;
|
|
return 0;
|
|
}
|
|
|
|
int zmq::msg_t::init_size (size_t size_)
|
|
{
|
|
if (size_ <= max_vsm_size) {
|
|
_u.vsm.metadata = NULL;
|
|
_u.vsm.type = type_vsm;
|
|
_u.vsm.flags = 0;
|
|
_u.vsm.size = static_cast<unsigned char> (size_);
|
|
_u.vsm.group[0] = '\0';
|
|
_u.vsm.routing_id = 0;
|
|
} else {
|
|
_u.lmsg.metadata = NULL;
|
|
_u.lmsg.type = type_lmsg;
|
|
_u.lmsg.flags = 0;
|
|
_u.lmsg.group[0] = '\0';
|
|
_u.lmsg.routing_id = 0;
|
|
_u.lmsg.content = NULL;
|
|
if (sizeof (content_t) + size_ > size_)
|
|
_u.lmsg.content =
|
|
static_cast<content_t *> (malloc (sizeof (content_t) + size_));
|
|
if (unlikely (!_u.lmsg.content)) {
|
|
errno = ENOMEM;
|
|
return -1;
|
|
}
|
|
|
|
_u.lmsg.content->data = _u.lmsg.content + 1;
|
|
_u.lmsg.content->size = size_;
|
|
_u.lmsg.content->ffn = NULL;
|
|
_u.lmsg.content->hint = NULL;
|
|
new (&_u.lmsg.content->refcnt) zmq::atomic_counter_t ();
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
int zmq::msg_t::init_external_storage (content_t *content_,
|
|
void *data_,
|
|
size_t size_,
|
|
msg_free_fn *ffn_,
|
|
void *hint_)
|
|
{
|
|
zmq_assert (NULL != data_);
|
|
zmq_assert (NULL != content_);
|
|
|
|
_u.zclmsg.metadata = NULL;
|
|
_u.zclmsg.type = type_zclmsg;
|
|
_u.zclmsg.flags = 0;
|
|
_u.zclmsg.group[0] = '\0';
|
|
_u.zclmsg.routing_id = 0;
|
|
|
|
_u.zclmsg.content = content_;
|
|
_u.zclmsg.content->data = data_;
|
|
_u.zclmsg.content->size = size_;
|
|
_u.zclmsg.content->ffn = ffn_;
|
|
_u.zclmsg.content->hint = hint_;
|
|
new (&_u.zclmsg.content->refcnt) zmq::atomic_counter_t ();
|
|
|
|
return 0;
|
|
}
|
|
|
|
int zmq::msg_t::init_data (void *data_,
|
|
size_t size_,
|
|
msg_free_fn *ffn_,
|
|
void *hint_)
|
|
{
|
|
// If data is NULL and size is not 0, a segfault
|
|
// would occur once the data is accessed
|
|
zmq_assert (data_ != NULL || size_ == 0);
|
|
|
|
// Initialize constant message if there's no need to deallocate
|
|
if (ffn_ == NULL) {
|
|
_u.cmsg.metadata = NULL;
|
|
_u.cmsg.type = type_cmsg;
|
|
_u.cmsg.flags = 0;
|
|
_u.cmsg.data = data_;
|
|
_u.cmsg.size = size_;
|
|
_u.cmsg.group[0] = '\0';
|
|
_u.cmsg.routing_id = 0;
|
|
} else {
|
|
_u.lmsg.metadata = NULL;
|
|
_u.lmsg.type = type_lmsg;
|
|
_u.lmsg.flags = 0;
|
|
_u.lmsg.group[0] = '\0';
|
|
_u.lmsg.routing_id = 0;
|
|
_u.lmsg.content =
|
|
static_cast<content_t *> (malloc (sizeof (content_t)));
|
|
if (!_u.lmsg.content) {
|
|
errno = ENOMEM;
|
|
return -1;
|
|
}
|
|
|
|
_u.lmsg.content->data = data_;
|
|
_u.lmsg.content->size = size_;
|
|
_u.lmsg.content->ffn = ffn_;
|
|
_u.lmsg.content->hint = hint_;
|
|
new (&_u.lmsg.content->refcnt) zmq::atomic_counter_t ();
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
int zmq::msg_t::init_delimiter ()
|
|
{
|
|
_u.delimiter.metadata = NULL;
|
|
_u.delimiter.type = type_delimiter;
|
|
_u.delimiter.flags = 0;
|
|
_u.delimiter.group[0] = '\0';
|
|
_u.delimiter.routing_id = 0;
|
|
return 0;
|
|
}
|
|
|
|
int zmq::msg_t::init_join ()
|
|
{
|
|
_u.base.metadata = NULL;
|
|
_u.base.type = type_join;
|
|
_u.base.flags = 0;
|
|
_u.base.group[0] = '\0';
|
|
_u.base.routing_id = 0;
|
|
return 0;
|
|
}
|
|
|
|
int zmq::msg_t::init_leave ()
|
|
{
|
|
_u.base.metadata = NULL;
|
|
_u.base.type = type_leave;
|
|
_u.base.flags = 0;
|
|
_u.base.group[0] = '\0';
|
|
_u.base.routing_id = 0;
|
|
return 0;
|
|
}
|
|
|
|
int zmq::msg_t::init_subscribe (const size_t size_, const unsigned char *topic)
|
|
{
|
|
int rc = init_size (size_);
|
|
if (rc == 0) {
|
|
set_flags (zmq::msg_t::subscribe);
|
|
|
|
// We explicitly allow a NULL subscription with size zero
|
|
if (size_) {
|
|
assert (topic);
|
|
memcpy (data (), topic, size_);
|
|
}
|
|
}
|
|
return rc;
|
|
}
|
|
|
|
int zmq::msg_t::init_cancel (const size_t size_, const unsigned char *topic)
|
|
{
|
|
int rc = init_size (size_);
|
|
if (rc == 0) {
|
|
set_flags (zmq::msg_t::cancel);
|
|
|
|
// We explicitly allow a NULL subscription with size zero
|
|
if (size_) {
|
|
assert (topic);
|
|
memcpy (data (), topic, size_);
|
|
}
|
|
}
|
|
return rc;
|
|
}
|
|
|
|
int zmq::msg_t::close ()
|
|
{
|
|
// Check the validity of the message.
|
|
if (unlikely (!check ())) {
|
|
errno = EFAULT;
|
|
return -1;
|
|
}
|
|
|
|
if (_u.base.type == type_lmsg) {
|
|
// If the content is not shared, or if it is shared and the reference
|
|
// count has dropped to zero, deallocate it.
|
|
if (!(_u.lmsg.flags & msg_t::shared)
|
|
|| !_u.lmsg.content->refcnt.sub (1)) {
|
|
// We used "placement new" operator to initialize the reference
|
|
// counter so we call the destructor explicitly now.
|
|
_u.lmsg.content->refcnt.~atomic_counter_t ();
|
|
|
|
if (_u.lmsg.content->ffn)
|
|
_u.lmsg.content->ffn (_u.lmsg.content->data,
|
|
_u.lmsg.content->hint);
|
|
free (_u.lmsg.content);
|
|
}
|
|
}
|
|
|
|
if (is_zcmsg ()) {
|
|
zmq_assert (_u.zclmsg.content->ffn);
|
|
|
|
// If the content is not shared, or if it is shared and the reference
|
|
// count has dropped to zero, deallocate it.
|
|
if (!(_u.zclmsg.flags & msg_t::shared)
|
|
|| !_u.zclmsg.content->refcnt.sub (1)) {
|
|
// We used "placement new" operator to initialize the reference
|
|
// counter so we call the destructor explicitly now.
|
|
_u.zclmsg.content->refcnt.~atomic_counter_t ();
|
|
|
|
_u.zclmsg.content->ffn (_u.zclmsg.content->data,
|
|
_u.zclmsg.content->hint);
|
|
}
|
|
}
|
|
|
|
if (_u.base.metadata != NULL) {
|
|
if (_u.base.metadata->drop_ref ()) {
|
|
LIBZMQ_DELETE (_u.base.metadata);
|
|
}
|
|
_u.base.metadata = NULL;
|
|
}
|
|
|
|
// Make the message invalid.
|
|
_u.base.type = 0;
|
|
|
|
return 0;
|
|
}
|
|
|
|
int zmq::msg_t::move (msg_t &src_)
|
|
{
|
|
// Check the validity of the source.
|
|
if (unlikely (!src_.check ())) {
|
|
errno = EFAULT;
|
|
return -1;
|
|
}
|
|
|
|
int rc = close ();
|
|
if (unlikely (rc < 0))
|
|
return rc;
|
|
|
|
*this = src_;
|
|
|
|
rc = src_.init ();
|
|
if (unlikely (rc < 0))
|
|
return rc;
|
|
|
|
return 0;
|
|
}
|
|
|
|
int zmq::msg_t::copy (msg_t &src_)
|
|
{
|
|
// Check the validity of the source.
|
|
if (unlikely (!src_.check ())) {
|
|
errno = EFAULT;
|
|
return -1;
|
|
}
|
|
|
|
const int rc = close ();
|
|
if (unlikely (rc < 0))
|
|
return rc;
|
|
|
|
// The initial reference count, when a non-shared message is initially
|
|
// shared (between the original and the copy we create here).
|
|
const atomic_counter_t::integer_t initial_shared_refcnt = 2;
|
|
|
|
if (src_.is_lmsg () || src_.is_zcmsg ()) {
|
|
// One reference is added to shared messages. Non-shared messages
|
|
// are turned into shared messages.
|
|
if (src_.flags () & msg_t::shared)
|
|
src_.refcnt ()->add (1);
|
|
else {
|
|
src_.set_flags (msg_t::shared);
|
|
src_.refcnt ()->set (initial_shared_refcnt);
|
|
}
|
|
}
|
|
|
|
if (src_._u.base.metadata != NULL)
|
|
src_._u.base.metadata->add_ref ();
|
|
|
|
*this = src_;
|
|
|
|
return 0;
|
|
}
|
|
|
|
void *zmq::msg_t::data ()
|
|
{
|
|
// Check the validity of the message.
|
|
zmq_assert (check ());
|
|
|
|
switch (_u.base.type) {
|
|
case type_vsm:
|
|
return _u.vsm.data;
|
|
case type_lmsg:
|
|
return _u.lmsg.content->data;
|
|
case type_cmsg:
|
|
return _u.cmsg.data;
|
|
case type_zclmsg:
|
|
return _u.zclmsg.content->data;
|
|
default:
|
|
zmq_assert (false);
|
|
return NULL;
|
|
}
|
|
}
|
|
|
|
size_t zmq::msg_t::size () const
|
|
{
|
|
// Check the validity of the message.
|
|
zmq_assert (check ());
|
|
|
|
switch (_u.base.type) {
|
|
case type_vsm:
|
|
return _u.vsm.size;
|
|
case type_lmsg:
|
|
return _u.lmsg.content->size;
|
|
case type_zclmsg:
|
|
return _u.zclmsg.content->size;
|
|
case type_cmsg:
|
|
return _u.cmsg.size;
|
|
default:
|
|
zmq_assert (false);
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
void zmq::msg_t::shrink (size_t new_size_)
|
|
{
|
|
// Check the validity of the message.
|
|
zmq_assert (check ());
|
|
zmq_assert (new_size_ <= size ());
|
|
|
|
switch (_u.base.type) {
|
|
case type_vsm:
|
|
_u.vsm.size = static_cast<unsigned char> (new_size_);
|
|
break;
|
|
case type_lmsg:
|
|
_u.lmsg.content->size = new_size_;
|
|
break;
|
|
case type_zclmsg:
|
|
_u.zclmsg.content->size = new_size_;
|
|
break;
|
|
case type_cmsg:
|
|
_u.cmsg.size = new_size_;
|
|
break;
|
|
default:
|
|
zmq_assert (false);
|
|
}
|
|
}
|
|
|
|
unsigned char zmq::msg_t::flags () const
|
|
{
|
|
return _u.base.flags;
|
|
}
|
|
|
|
void zmq::msg_t::set_flags (unsigned char flags_)
|
|
{
|
|
_u.base.flags |= flags_;
|
|
}
|
|
|
|
void zmq::msg_t::reset_flags (unsigned char flags_)
|
|
{
|
|
_u.base.flags &= ~flags_;
|
|
}
|
|
|
|
zmq::metadata_t *zmq::msg_t::metadata () const
|
|
{
|
|
return _u.base.metadata;
|
|
}
|
|
|
|
void zmq::msg_t::set_metadata (zmq::metadata_t *metadata_)
|
|
{
|
|
assert (metadata_ != NULL);
|
|
assert (_u.base.metadata == NULL);
|
|
metadata_->add_ref ();
|
|
_u.base.metadata = metadata_;
|
|
}
|
|
|
|
void zmq::msg_t::reset_metadata ()
|
|
{
|
|
if (_u.base.metadata) {
|
|
if (_u.base.metadata->drop_ref ()) {
|
|
LIBZMQ_DELETE (_u.base.metadata);
|
|
}
|
|
_u.base.metadata = NULL;
|
|
}
|
|
}
|
|
|
|
bool zmq::msg_t::is_routing_id () const
|
|
{
|
|
return (_u.base.flags & routing_id) == routing_id;
|
|
}
|
|
|
|
bool zmq::msg_t::is_credential () const
|
|
{
|
|
return (_u.base.flags & credential) == credential;
|
|
}
|
|
|
|
bool zmq::msg_t::is_delimiter () const
|
|
{
|
|
return _u.base.type == type_delimiter;
|
|
}
|
|
|
|
bool zmq::msg_t::is_vsm () const
|
|
{
|
|
return _u.base.type == type_vsm;
|
|
}
|
|
|
|
bool zmq::msg_t::is_cmsg () const
|
|
{
|
|
return _u.base.type == type_cmsg;
|
|
}
|
|
|
|
bool zmq::msg_t::is_lmsg () const
|
|
{
|
|
return _u.base.type == type_lmsg;
|
|
}
|
|
|
|
bool zmq::msg_t::is_zcmsg () const
|
|
{
|
|
return _u.base.type == type_zclmsg;
|
|
}
|
|
|
|
bool zmq::msg_t::is_join () const
|
|
{
|
|
return _u.base.type == type_join;
|
|
}
|
|
|
|
bool zmq::msg_t::is_leave () const
|
|
{
|
|
return _u.base.type == type_leave;
|
|
}
|
|
|
|
bool zmq::msg_t::is_ping () const
|
|
{
|
|
return (_u.base.flags & CMD_TYPE_MASK) == ping;
|
|
}
|
|
|
|
bool zmq::msg_t::is_pong () const
|
|
{
|
|
return (_u.base.flags & CMD_TYPE_MASK) == pong;
|
|
}
|
|
|
|
bool zmq::msg_t::is_close_cmd () const
|
|
{
|
|
return (_u.base.flags & CMD_TYPE_MASK) == close_cmd;
|
|
}
|
|
|
|
size_t zmq::msg_t::command_body_size () const
|
|
{
|
|
if (this->is_ping () || this->is_pong ())
|
|
return this->size () - ping_cmd_name_size;
|
|
else if (!(this->flags () & msg_t::command)
|
|
&& (this->is_subscribe () || this->is_cancel ()))
|
|
return this->size ();
|
|
else if (this->is_subscribe ())
|
|
return this->size () - sub_cmd_name_size;
|
|
else if (this->is_cancel ())
|
|
return this->size () - cancel_cmd_name_size;
|
|
|
|
return 0;
|
|
}
|
|
|
|
void *zmq::msg_t::command_body ()
|
|
{
|
|
unsigned char *data = NULL;
|
|
|
|
if (this->is_ping () || this->is_pong ())
|
|
data =
|
|
static_cast<unsigned char *> (this->data ()) + ping_cmd_name_size;
|
|
// With inproc, command flag is not set for sub/cancel
|
|
else if (!(this->flags () & msg_t::command)
|
|
&& (this->is_subscribe () || this->is_cancel ()))
|
|
data = static_cast<unsigned char *> (this->data ());
|
|
else if (this->is_subscribe ())
|
|
data = static_cast<unsigned char *> (this->data ()) + sub_cmd_name_size;
|
|
else if (this->is_cancel ())
|
|
data =
|
|
static_cast<unsigned char *> (this->data ()) + cancel_cmd_name_size;
|
|
|
|
return data;
|
|
}
|
|
|
|
void zmq::msg_t::add_refs (int refs_)
|
|
{
|
|
zmq_assert (refs_ >= 0);
|
|
|
|
// Operation not supported for messages with metadata.
|
|
zmq_assert (_u.base.metadata == NULL);
|
|
|
|
// No copies required.
|
|
if (!refs_)
|
|
return;
|
|
|
|
// VSMs, CMSGS and delimiters can be copied straight away. The only
|
|
// message type that needs special care are long messages.
|
|
if (_u.base.type == type_lmsg || is_zcmsg ()) {
|
|
if (_u.base.flags & msg_t::shared)
|
|
refcnt ()->add (refs_);
|
|
else {
|
|
refcnt ()->set (refs_ + 1);
|
|
_u.base.flags |= msg_t::shared;
|
|
}
|
|
}
|
|
}
|
|
|
|
bool zmq::msg_t::rm_refs (int refs_)
|
|
{
|
|
zmq_assert (refs_ >= 0);
|
|
|
|
// Operation not supported for messages with metadata.
|
|
zmq_assert (_u.base.metadata == NULL);
|
|
|
|
// No copies required.
|
|
if (!refs_)
|
|
return true;
|
|
|
|
// If there's only one reference close the message.
|
|
if ((_u.base.type != type_zclmsg && _u.base.type != type_lmsg)
|
|
|| !(_u.base.flags & msg_t::shared)) {
|
|
close ();
|
|
return false;
|
|
}
|
|
|
|
// The only message type that needs special care are long and zcopy messages.
|
|
if (_u.base.type == type_lmsg && !_u.lmsg.content->refcnt.sub (refs_)) {
|
|
// We used "placement new" operator to initialize the reference
|
|
// counter so we call the destructor explicitly now.
|
|
_u.lmsg.content->refcnt.~atomic_counter_t ();
|
|
|
|
if (_u.lmsg.content->ffn)
|
|
_u.lmsg.content->ffn (_u.lmsg.content->data, _u.lmsg.content->hint);
|
|
free (_u.lmsg.content);
|
|
|
|
return false;
|
|
}
|
|
|
|
if (is_zcmsg () && !_u.zclmsg.content->refcnt.sub (refs_)) {
|
|
// storage for rfcnt is provided externally
|
|
if (_u.zclmsg.content->ffn) {
|
|
_u.zclmsg.content->ffn (_u.zclmsg.content->data,
|
|
_u.zclmsg.content->hint);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
uint32_t zmq::msg_t::get_routing_id () const
|
|
{
|
|
return _u.base.routing_id;
|
|
}
|
|
|
|
int zmq::msg_t::set_routing_id (uint32_t routing_id_)
|
|
{
|
|
if (routing_id_) {
|
|
_u.base.routing_id = routing_id_;
|
|
return 0;
|
|
}
|
|
errno = EINVAL;
|
|
return -1;
|
|
}
|
|
|
|
int zmq::msg_t::reset_routing_id ()
|
|
{
|
|
_u.base.routing_id = 0;
|
|
return 0;
|
|
}
|
|
|
|
const char *zmq::msg_t::group () const
|
|
{
|
|
return _u.base.group;
|
|
}
|
|
|
|
int zmq::msg_t::set_group (const char *group_)
|
|
{
|
|
return set_group (group_, ZMQ_GROUP_MAX_LENGTH);
|
|
}
|
|
|
|
int zmq::msg_t::set_group (const char *group_, size_t length_)
|
|
{
|
|
if (length_ > ZMQ_GROUP_MAX_LENGTH) {
|
|
errno = EINVAL;
|
|
return -1;
|
|
}
|
|
|
|
strncpy (_u.base.group, group_, length_);
|
|
_u.base.group[length_] = '\0';
|
|
|
|
return 0;
|
|
}
|
|
|
|
zmq::atomic_counter_t *zmq::msg_t::refcnt ()
|
|
{
|
|
switch (_u.base.type) {
|
|
case type_lmsg:
|
|
return &_u.lmsg.content->refcnt;
|
|
case type_zclmsg:
|
|
return &_u.zclmsg.content->refcnt;
|
|
default:
|
|
zmq_assert (false);
|
|
return NULL;
|
|
}
|
|
}
|