rbczmq 1.6.2 → 1.6.4

data/ext/zeromq/src/pipe.hpp

@@ -0,0 +1,207 @@
+/*
+    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_PIPE_HPP_INCLUDED__
+#define __ZMQ_PIPE_HPP_INCLUDED__
+
+#include "msg.hpp"
+#include "ypipe.hpp"
+#include "config.hpp"
+#include "object.hpp"
+#include "stdint.hpp"
+#include "array.hpp"
+#include "blob.hpp"
+
+namespace zmq
+{
+
+    class object_t;
+    class pipe_t;
+
+    //  Create a pipepair for bi-directional transfer of messages.
+    //  First HWM is for messages passed from first pipe to the second pipe.
+    //  Second HWM is for messages passed from second pipe to the first pipe.
+    //  Delay specifies how the pipe behaves when the peer terminates. If true
+    //  pipe receives all the pending messages before terminating, otherwise it
+    //  terminates straight away.
+    int pipepair (zmq::object_t *parents_ [2], zmq::pipe_t* pipes_ [2],
+        int hwms_ [2], bool delays_ [2]);
+
+    struct i_pipe_events
+    {
+        virtual ~i_pipe_events () {}
+
+        virtual void read_activated (zmq::pipe_t *pipe_) = 0;
+        virtual void write_activated (zmq::pipe_t *pipe_) = 0;
+        virtual void hiccuped (zmq::pipe_t *pipe_) = 0;
+        virtual void terminated (zmq::pipe_t *pipe_) = 0;
+    };
+
+    //  Note that pipe can be stored in three different arrays.
+    //  The array of inbound pipes (1), the array of outbound pipes (2) and
+    //  the generic array of pipes to deallocate (3).
+
+    class pipe_t :
+        public object_t,
+        public array_item_t <1>,
+        public array_item_t <2>,
+        public array_item_t <3>
+    {
+        //  This allows pipepair to create pipe objects.
+        friend int pipepair (zmq::object_t *parents_ [2],
+            zmq::pipe_t* pipes_ [2], int hwms_ [2], bool delays_ [2]);
+
+    public:
+
+        //  Specifies the object to send events to.
+        void set_event_sink (i_pipe_events *sink_);
+
+        //  Pipe endpoint can store an opaque ID to be used by its clients.
+        void set_identity (const blob_t &identity_);
+        blob_t get_identity ();
+
+        //  Returns true if there is at least one message to read in the pipe.
+        bool check_read ();
+
+        //  Reads a message to the underlying pipe.
+        bool read (msg_t *msg_);
+
+        //  Checks whether messages can be written to the pipe. If writing
+        //  the message would cause high watermark the function returns false.
+        bool check_write ();
+
+        //  Writes a message to the underlying pipe. Returns false if the
+        //  message cannot be written because high watermark was reached.
+        bool write (msg_t *msg_);
+
+        //  Remove unfinished parts of the outbound message from the pipe.
+        void rollback ();
+
+        //  Flush the messages downsteam.
+        void flush ();
+
+        //  Temporaraily disconnects the inbound message stream and drops
+        //  all the messages on the fly. Causes 'hiccuped' event to be generated
+        //  in the peer.
+        void hiccup ();
+
+        //  Ask pipe to terminate. The termination will happen asynchronously
+        //  and user will be notified about actual deallocation by 'terminated'
+        //  event. If delay is true, the pending messages will be processed
+        //  before actual shutdown.
+        void terminate (bool delay_);
+
+    private:
+
+        //  Type of the underlying lock-free pipe.
+        typedef ypipe_t <msg_t, message_pipe_granularity> upipe_t;
+
+        //  Command handlers.
+        void process_activate_read ();
+        void process_activate_write (uint64_t msgs_read_);
+        void process_hiccup (void *pipe_);
+        void process_pipe_term ();
+        void process_pipe_term_ack ();
+
+        //  Handler for delimiter read from the pipe.
+        void delimit ();
+
+        //  Constructor is private. Pipe can only be created using
+        //  pipepair function.
+        pipe_t (object_t *parent_, upipe_t *inpipe_, upipe_t *outpipe_,
+            int inhwm_, int outhwm_, bool delay_);
+
+        //  Pipepair uses this function to let us know about
+        //  the peer pipe object.
+        void set_peer (pipe_t *pipe_);
+
+        //  Destructor is private. Pipe objects destroy themselves.
+        ~pipe_t ();
+
+        //  Underlying pipes for both directions.
+        upipe_t *inpipe;
+        upipe_t *outpipe;
+
+        //  Can the pipe be read from / written to?
+        bool in_active;
+        bool out_active;
+
+        //  High watermark for the outbound pipe.
+        int hwm;
+
+        //  Low watermark for the inbound pipe.
+        int lwm;
+
+        //  Number of messages read and written so far.
+        uint64_t msgs_read;
+        uint64_t msgs_written;
+
+        //  Last received peer's msgs_read. The actual number in the peer
+        //  can be higher at the moment.
+        uint64_t peers_msgs_read;
+
+        //  The pipe object on the other side of the pipepair.
+        pipe_t *peer;
+
+        //  Sink to send events to.
+        i_pipe_events *sink;
+
+        //  State of the pipe endpoint. Active is common state before any
+        //  termination begins. Delimited means that delimiter was read from
+        //  pipe before term command was received. Pending means that term
+        //  command was already received from the peer but there are still
+        //  pending messages to read. Terminating means that all pending
+        //  messages were already read and all we are waiting for is ack from
+        //  the peer. Terminated means that 'terminate' was explicitly called
+        //  by the user. Double_terminated means that user called 'terminate'
+        //  and then we've got term command from the peer as well.
+        enum {
+            active,
+            delimited,
+            pending,
+            terminating,
+            terminated,
+            double_terminated
+        } state;
+
+        //  If true, we receive all the pending inbound messages before
+        //  terminating. If false, we terminate immediately when the peer
+        //  asks us to.
+        bool delay;
+
+        //  Identity of the writer. Used uniquely by the reader side.
+        blob_t identity;
+
+        //  Returns true if the message is delimiter; false otherwise.
+        static bool is_delimiter (msg_t &msg_);
+
+        //  Computes appropriate low watermark from the given high watermark.
+        static int compute_lwm (int hwm_);
+
+        //  Disable copying.
+        pipe_t (const pipe_t&);
+        const pipe_t &operator = (const pipe_t&);
+    };
+
+}
+
+#endif

data/ext/zeromq/src/poll.cpp

@@ -0,0 +1,176 @@
+/*
+    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/>.
+*/
+
+#include "poll.hpp"
+#if defined ZMQ_USE_POLL
+
+#include <sys/types.h>
+#include <sys/time.h>
+#include <poll.h>
+#include <algorithm>
+
+#include "poll.hpp"
+#include "err.hpp"
+#include "config.hpp"
+#include "i_poll_events.hpp"
+
+zmq::poll_t::poll_t () :
+    retired (false),
+    stopping (false)
+{
+}
+
+zmq::poll_t::~poll_t ()
+{
+    worker.stop ();
+}
+
+zmq::poll_t::handle_t zmq::poll_t::add_fd (fd_t fd_, i_poll_events *events_)
+{
+    //  If the file descriptor table is too small expand it.
+    fd_table_t::size_type sz = fd_table.size ();
+    if (sz <= (fd_table_t::size_type) fd_) {
+        fd_table.resize (fd_ + 1);
+        while (sz != (fd_table_t::size_type) (fd_ + 1)) {
+            fd_table [sz].index = retired_fd;
+            ++sz;
+        }
+    }
+
+    pollfd pfd = {fd_, 0, 0};
+    pollset.push_back (pfd);
+    zmq_assert (fd_table [fd_].index == retired_fd);
+
+    fd_table [fd_].index = pollset.size() - 1;
+    fd_table [fd_].events = events_;
+
+    //  Increase the load metric of the thread.
+    adjust_load (1);
+
+    return fd_;
+}
+
+void zmq::poll_t::rm_fd (handle_t handle_)
+{
+    fd_t index = fd_table [handle_].index;
+    zmq_assert (index != retired_fd);
+
+    //  Mark the fd as unused.
+    pollset [index].fd = retired_fd;
+    fd_table [handle_].index = retired_fd;
+    retired = true;
+
+    //  Decrease the load metric of the thread.
+    adjust_load (-1);
+}
+
+void zmq::poll_t::set_pollin (handle_t handle_)
+{
+    int index = fd_table [handle_].index;
+    pollset [index].events |= POLLIN;
+}
+
+void zmq::poll_t::reset_pollin (handle_t handle_)
+{
+    int index = fd_table [handle_].index;
+    pollset [index].events &= ~((short) POLLIN);
+}
+
+void zmq::poll_t::set_pollout (handle_t handle_)
+{
+    int index = fd_table [handle_].index;
+    pollset [index].events |= POLLOUT;
+}
+
+void zmq::poll_t::reset_pollout (handle_t handle_)
+{
+    int index = fd_table [handle_].index;
+    pollset [index].events &= ~((short) POLLOUT);
+}
+
+void zmq::poll_t::start ()
+{
+    worker.start (worker_routine, this);
+}
+
+void zmq::poll_t::stop ()
+{
+    stopping = true;
+}
+
+void zmq::poll_t::loop ()
+{
+    while (!stopping) {
+
+        //  Execute any due timers.
+        int timeout = (int) execute_timers ();
+
+        //  Wait for events.
+        int rc = poll (&pollset [0], pollset.size (), timeout ? timeout : -1);
+        if (rc == -1) {
+            errno_assert (errno == EINTR);
+            continue;
+        }
+
+        //  If there are no events (i.e. it's a timeout) there's no point
+        //  in checking the pollset.
+        if (rc == 0)
+            continue;
+
+        for (pollset_t::size_type i = 0; i != pollset.size (); i++) {
+
+            zmq_assert (!(pollset [i].revents & POLLNVAL));
+            if (pollset [i].fd == retired_fd)
+               continue;
+            if (pollset [i].revents & (POLLERR | POLLHUP))
+                fd_table [pollset [i].fd].events->in_event ();
+            if (pollset [i].fd == retired_fd)
+               continue;
+            if (pollset [i].revents & POLLOUT)
+                fd_table [pollset [i].fd].events->out_event ();
+            if (pollset [i].fd == retired_fd)
+               continue;
+            if (pollset [i].revents & POLLIN)
+                fd_table [pollset [i].fd].events->in_event ();
+        }
+
+        //  Clean up the pollset and update the fd_table accordingly.
+        if (retired) {
+            pollset_t::size_type i = 0;
+            while (i < pollset.size ()) {
+                if (pollset [i].fd == retired_fd)
+                    pollset.erase (pollset.begin () + i);
+                else {
+                    fd_table [pollset [i].fd].index = i;
+                    i ++;
+                }
+            }
+            retired = false;
+        }
+    }
+}
+
+void zmq::poll_t::worker_routine (void *arg_)
+{
+    ((poll_t*) arg_)->loop ();
+}
+
+#endif

data/ext/zeromq/src/poll.hpp

@@ -0,0 +1,105 @@
+/*
+    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_POLL_HPP_INCLUDED__
+#define __ZMQ_POLL_HPP_INCLUDED__
+
+//  poller.hpp decides which polling mechanism to use.
+#include "poller.hpp"
+#if defined ZMQ_USE_POLL
+
+#include <poll.h>
+#include <stddef.h>
+#include <vector>
+
+#include "fd.hpp"
+#include "thread.hpp"
+#include "poller_base.hpp"
+
+namespace zmq
+{
+
+    struct i_poll_events;
+
+    //  Implements socket polling mechanism using the POSIX.1-2001
+    //  poll() system call.
+
+    class poll_t : public poller_base_t
+    {
+    public:
+
+        typedef fd_t handle_t;
+
+        poll_t ();
+        ~poll_t ();
+
+        //  "poller" concept.
+        handle_t add_fd (fd_t fd_, zmq::i_poll_events *events_);
+        void rm_fd (handle_t handle_);
+        void set_pollin (handle_t handle_);
+        void reset_pollin (handle_t handle_);
+        void set_pollout (handle_t handle_);
+        void reset_pollout (handle_t handle_);
+        void start ();
+        void stop ();
+
+    private:
+
+        //  Main worker thread routine.
+        static void worker_routine (void *arg_);
+
+        //  Main event loop.
+        void loop ();
+
+        struct fd_entry_t
+        {
+            fd_t index;
+            zmq::i_poll_events *events;
+        };
+
+        //  This table stores data for registered descriptors.
+        typedef std::vector <fd_entry_t> fd_table_t;
+        fd_table_t fd_table;
+
+        //  Pollset to pass to the poll function.
+        typedef std::vector <pollfd> pollset_t;
+        pollset_t pollset;
+
+        //  If true, there's at least one retired event source.
+        bool retired;
+
+        //  If true, thread is in the process of shutting down.
+        bool stopping;
+
+        //  Handle of the physical thread doing the I/O work.
+        thread_t worker;
+
+        poll_t (const poll_t&);
+        const poll_t &operator = (const poll_t&);
+    };
+
+    typedef poll_t poller_t;
+
+}
+
+#endif
+
+#endif