rbczmq 1.6.2 → 1.6.4

data/ext/zeromq/src/mailbox.hpp

@@ -0,0 +1,75 @@
+/*
+    Copyright (c) 2009-2011 250bpm s.r.o.
+    Copyright (c) 2007-2009 iMatix Corporation
+    Copyright (c) 2007-2011 Other contributors as noted in the AUTHORS file
+
+    This file is part of 0MQ.
+
+    0MQ is free software; you can redistribute it and/or modify it under
+    the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation; either version 3 of the License, or
+    (at your option) any later version.
+
+    0MQ 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/>.
+*/
+
+#ifndef __ZMQ_MAILBOX_HPP_INCLUDED__
+#define __ZMQ_MAILBOX_HPP_INCLUDED__
+
+#include <stddef.h>
+
+#include "platform.hpp"
+#include "signaler.hpp"
+#include "fd.hpp"
+#include "config.hpp"
+#include "command.hpp"
+#include "ypipe.hpp"
+#include "mutex.hpp"
+
+namespace zmq
+{
+
+    class mailbox_t
+    {
+    public:
+
+        mailbox_t ();
+        ~mailbox_t ();
+
+        fd_t get_fd ();
+        void send (const command_t &cmd_);
+        int recv (command_t *cmd_, int timeout_);
+        
+    private:
+
+        //  The pipe to store actual commands.
+        typedef ypipe_t <command_t, command_pipe_granularity> cpipe_t;
+        cpipe_t cpipe;
+
+        //  Signaler to pass signals from writer thread to reader thread.
+        signaler_t signaler;
+
+        //  There's only one thread receiving from the mailbox, but there
+        //  is arbitrary number of threads sending. Given that ypipe requires
+        //  synchronised access on both of its endpoints, we have to synchronise
+        //  the sending side.
+        mutex_t sync;
+
+        //  True if the underlying pipe is active, ie. when we are allowed to
+        //  read commands from it.
+        bool active;
+
+        //  Disable copying of mailbox_t object.
+        mailbox_t (const mailbox_t&);
+        const mailbox_t &operator = (const mailbox_t&);
+    };
+
+}
+
+#endif

data/ext/zeromq/src/msg.cpp

@@ -0,0 +1,299 @@
+/*
+    Copyright (c) 2007-2012 iMatix Corporation
+    Copyright (c) 2009-2011 250bpm s.r.o.
+    Copyright (c) 2007-2011 Other contributors as noted in the AUTHORS file
+
+    This file is part of 0MQ.
+
+    0MQ is free software; you can redistribute it and/or modify it under
+    the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation; either version 3 of the License, or
+    (at your option) any later version.
+
+    0MQ 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 "msg.hpp"
+#include "../include/zmq.h"
+
+#include <string.h>
+#include <stdlib.h>
+#include <new>
+
+#include "stdint.hpp"
+#include "likely.hpp"
+#include "err.hpp"
+
+//  Check whether the sizes of public representation of the message (zmq_msg_t)
+//  and private represenation 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 ()
+{
+     return u.base.type >= type_min && u.base.type <= type_max;
+}
+
+int zmq::msg_t::init ()
+{
+    u.vsm.type = type_vsm;
+    u.vsm.flags = 0;
+    u.vsm.size = 0;
+    return 0;
+}
+
+int zmq::msg_t::init_size (size_t size_)
+{
+    if (size_ <= max_vsm_size) {
+        u.vsm.type = type_vsm;
+        u.vsm.flags = 0;
+        u.vsm.size = (unsigned char) size_;
+    }
+    else {
+        u.lmsg.type = type_lmsg;
+        u.lmsg.flags = 0;
+        u.lmsg.content =
+            (content_t*) malloc (sizeof (content_t) + size_);
+        if (!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_data (void *data_, size_t size_, msg_free_fn *ffn_,
+    void *hint_)
+{
+    u.lmsg.type = type_lmsg;
+    u.lmsg.flags = 0;
+    u.lmsg.content = (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.type = type_delimiter;
+    u.delimiter.flags = 0;
+    return 0;
+}
+
+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);
+        }
+    }
+
+    //  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;
+    }
+
+    int rc = close ();
+    if (unlikely (rc < 0))
+        return rc;
+
+    if (src_.u.base.type == type_lmsg) {
+
+        //  One reference is added to shared messages. Non-shared messages
+        //  are turned into shared messages and reference count is set to 2.
+        if (src_.u.lmsg.flags & msg_t::shared)
+            src_.u.lmsg.content->refcnt.add (1);
+        else {
+            src_.u.lmsg.flags |= msg_t::shared;
+            src_.u.lmsg.content->refcnt.set (2);
+        }
+    }
+
+    *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;
+    default:
+        zmq_assert (false);
+        return NULL;
+    }
+}
+
+size_t zmq::msg_t::size ()
+{
+    //  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;
+    default:
+        zmq_assert (false);
+        return 0;
+    }
+}
+
+unsigned char zmq::msg_t::flags ()
+{
+    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_;
+}
+
+bool zmq::msg_t::is_identity () const
+{
+    return (u.base.flags & identity) == identity;
+}
+
+bool zmq::msg_t::is_delimiter ()
+{
+    return u.base.type == type_delimiter;
+}
+
+bool zmq::msg_t::is_vsm ()
+{
+    return u.base.type == type_vsm;
+}
+
+void zmq::msg_t::add_refs (int refs_)
+{
+    zmq_assert (refs_ >= 0);
+
+    //  No copies required.
+    if (!refs_)
+        return;
+
+    //  VSMs and delimiters can be copied straight away. The only message type
+    //  that needs special care are long messages.
+    if (u.base.type == type_lmsg) {
+        if (u.lmsg.flags & msg_t::shared)
+            u.lmsg.content->refcnt.add (refs_);
+        else {
+            u.lmsg.content->refcnt.set (refs_ + 1);
+            u.lmsg.flags |= msg_t::shared;
+        }
+    }
+}
+
+bool zmq::msg_t::rm_refs (int refs_)
+{
+    zmq_assert (refs_ >= 0);
+
+    //  No copies required.
+    if (!refs_)
+        return true;
+
+    //  If there's only one reference close the message.
+    if (u.base.type != type_lmsg || !(u.lmsg.flags & msg_t::shared)) {
+        close ();
+        return false;
+    }
+
+    //  The only message type that needs special care are long messages.
+    if (!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;
+    }
+
+    return true;
+}
+

data/ext/zeromq/src/msg.hpp

@@ -0,0 +1,148 @@
+/*
+    Copyright (c) 2009-2011 250bpm s.r.o.
+    Copyright (c) 2007-2009 iMatix Corporation
+    Copyright (c) 2011 VMware, Inc.
+    Copyright (c) 2007-2011 Other contributors as noted in the AUTHORS file
+
+    This file is part of 0MQ.
+
+    0MQ is free software; you can redistribute it and/or modify it under
+    the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation; either version 3 of the License, or
+    (at your option) any later version.
+
+    0MQ 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/>.
+*/
+
+#ifndef __ZMQ_MSG_HPP_INCLUDE__
+#define __ZMQ_MSG_HPP_INCLUDE__
+
+#include <stddef.h>
+#include <stdio.h>
+
+#include "config.hpp"
+#include "atomic_counter.hpp"
+
+//  Signature for free function to deallocate the message content.
+//  Note that it has to be declared as "C" so that it is the same as
+//  zmq_free_fn defined in zmq.h.
+extern "C"
+{
+    typedef void (msg_free_fn) (void *data, void *hint);
+}
+
+namespace zmq
+{
+
+    //  Note that this structure needs to be explicitly constructed
+    //  (init functions) and destructed (close function).
+
+    class msg_t
+    {
+    public:
+
+        //  Mesage flags.
+        enum
+        {
+            more = 1,
+            identity = 64,
+            shared = 128
+        };
+
+        bool check ();
+        int init ();
+        int init_size (size_t size_);
+        int init_data (void *data_, size_t size_, msg_free_fn *ffn_,
+            void *hint_);
+        int init_delimiter ();
+        int close ();
+        int move (msg_t &src_);
+        int copy (msg_t &src_);
+        void *data ();
+        size_t size ();
+        unsigned char flags ();
+        void set_flags (unsigned char flags_);
+        void reset_flags (unsigned char flags_);
+        bool is_identity () const;
+        bool is_delimiter ();
+        bool is_vsm ();
+
+        //  After calling this function you can copy the message in POD-style
+        //  refs_ times. No need to call copy.
+        void add_refs (int refs_);
+
+        //  Removes references previously added by add_refs. If the number of
+        //  references drops to 0, the message is closed and false is returned.
+        bool rm_refs (int refs_);
+
+    private:
+
+        //  Size in bytes of the largest message that is still copied around
+        //  rather than being reference-counted.
+        enum {max_vsm_size = 29};
+
+        //  Shared message buffer. Message data are either allocated in one
+        //  continuous block along with this structure - thus avoiding one
+        //  malloc/free pair or they are stored in used-supplied memory.
+        //  In the latter case, ffn member stores pointer to the function to be
+        //  used to deallocate the data. If the buffer is actually shared (there
+        //  are at least 2 references to it) refcount member contains number of
+        //  references.
+        struct content_t
+        {
+            void *data;
+            size_t size;
+            msg_free_fn *ffn;
+            void *hint;
+            zmq::atomic_counter_t refcnt;
+        };
+
+        //  Different message types.
+        enum type_t
+        {
+            type_min = 101,
+            type_vsm = 101,
+            type_lmsg = 102,
+            type_delimiter = 103,
+            type_max = 103
+        };
+
+        //  Note that fields shared between different message types are not
+        //  moved to tha parent class (msg_t). This way we ger tighter packing
+        //  of the data. Shared fields can be accessed via 'base' member of
+        //  the union.
+        union {
+            struct {
+                unsigned char unused [max_vsm_size + 1];
+                unsigned char type;
+                unsigned char flags;
+            } base;
+            struct {
+                unsigned char data [max_vsm_size];
+                unsigned char size;
+                unsigned char type;
+                unsigned char flags;
+            } vsm;
+            struct {
+                content_t *content;
+                unsigned char unused [max_vsm_size + 1 - sizeof (content_t*)];
+                unsigned char type;
+                unsigned char flags;
+            } lmsg;
+            struct {
+                unsigned char unused [max_vsm_size + 1];
+                unsigned char type;
+                unsigned char flags;
+            } delimiter;
+        } u;
+    };
+
+}
+
+#endif