dispatcher.hpp 6.04 KB
Newer Older
Martin Sustrik's avatar
Martin Sustrik committed
1
/*
2
    Copyright (c) 2007-2010 iMatix Corporation
Martin Sustrik's avatar
Martin Sustrik committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

    This file is part of 0MQ.

    0MQ is free software; you can redistribute it and/or modify it under
    the terms of the Lesser GNU 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
    Lesser GNU General Public License for more details.

    You should have received a copy of the Lesser GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

20 21
#ifndef __ZMQ_DISPATCHER_HPP_INCLUDED__
#define __ZMQ_DISPATCHER_HPP_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
22 23

#include <vector>
Martin Sustrik's avatar
Martin Sustrik committed
24
#include <set>
Martin Sustrik's avatar
Martin Sustrik committed
25 26 27 28 29 30 31 32 33 34
#include <map>
#include <string>

#include "i_signaler.hpp"
#include "ypipe.hpp"
#include "command.hpp"
#include "config.hpp"
#include "mutex.hpp"
#include "stdint.hpp"

Martin Sustrik's avatar
Martin Sustrik committed
35
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
36 37 38 39 40
{

    //  Dispatcher implements bidirectional thread-safe passing of commands
    //  between N threads. It consists of a ypipes to pass commands and
    //  signalers to wake up the receiver thread when new commands are
41
    //  available. Note that dispatcher is inefficient for passing messages
Martin Sustrik's avatar
Martin Sustrik committed
42 43 44 45
    //  within a thread (sender thread = receiver thread). The optimisation is
    //  not part of the class and should be implemented by individual threads
    //  (presumably by calling the command handling function directly).
    
46
    class dispatcher_t
Martin Sustrik's avatar
Martin Sustrik committed
47 48 49
    {
    public:

50
        //  Create the dispatcher object. Matrix of pipes to communicate between
Martin Sustrik's avatar
Martin Sustrik committed
51 52
        //  each socket and each I/O thread is created along with appropriate
        //  signalers.
53
        dispatcher_t (int app_threads_, int io_threads_, int flags_);
Martin Sustrik's avatar
Martin Sustrik committed
54

55 56 57 58 59
        //  This function is called when user invokes zmq_term. If there are
        //  no more sockets open it'll cause all the infrastructure to be shut
        //  down. If there are open sockets still, the deallocation happens
        //  after the last one is closed.
        int term ();
Martin Sustrik's avatar
Martin Sustrik committed
60

61
        //  Create a socket.
62
        class socket_base_t *create_socket (int type_);
Martin Sustrik's avatar
Martin Sustrik committed
63

64 65 66
        //  Destroy a socket.
        void destroy_socket ();

67
        //  Returns number of thread slots in the dispatcher. To be used by
Martin Sustrik's avatar
Martin Sustrik committed
68 69 70 71
        //  individual threads to find out how many distinct signals can be
        //  received.
        int thread_slot_count ();

72
        //  Send command from the source to the destination.
Martin Sustrik's avatar
Martin Sustrik committed
73 74 75 76 77 78 79 80 81 82
        inline void write (int source_, int destination_,
            const command_t &command_)
        {
            command_pipe_t &pipe =
                command_pipes [source_ * signalers.size () + destination_];
            pipe.write (command_);
            if (!pipe.flush ())
                signalers [destination_]->signal (source_);
        }

83
        //  Receive command from the source. Returns false if there is no
Martin Sustrik's avatar
Martin Sustrik committed
84 85 86 87 88 89 90 91 92 93 94
        //  command available.
        inline bool read (int source_,  int destination_, command_t *command_)
        {
            return command_pipes [source_ * signalers.size () +
                destination_].read (command_);
        }

        //  Returns the I/O thread that is the least busy at the moment.
        //  Taskset specifies which I/O threads are eligible (0 = all).
        class io_thread_t *choose_io_thread (uint64_t taskset_);

Martin Sustrik's avatar
Martin Sustrik committed
95 96 97 98 99
        //  All pipes are registered with the dispatcher so that even the
        //  orphaned pipes can be deallocated on the terminal shutdown.
        void register_pipe (class pipe_t *pipe_);
        void unregister_pipe (class pipe_t *pipe_);

100 101 102 103 104
        //  Management of inproc endpoints.
        int register_endpoint (const char *addr_, class socket_base_t *socket_);
        void unregister_endpoints (class socket_base_t *socket_);
        class socket_base_t *find_endpoint (const char *addr_);

Martin Sustrik's avatar
Martin Sustrik committed
105 106
    private:

107 108
        ~dispatcher_t ();

Martin Sustrik's avatar
Martin Sustrik committed
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
        //  Returns the app thread associated with the current thread.
        //  NULL if we are out of app thread slots.
        class app_thread_t *choose_app_thread ();

        //  Application threads.
        typedef std::vector <class app_thread_t*> app_threads_t;
        app_threads_t app_threads;

        //  I/O threads.
        typedef std::vector <class io_thread_t*> io_threads_t;
        io_threads_t io_threads;

        //  Signalers for both application and I/O threads.
        std::vector <i_signaler*> signalers;

        //  Pipe to hold the commands.
        typedef ypipe_t <command_t, true,
            command_pipe_granularity> command_pipe_t;

        //  NxN matrix of command pipes.
        command_pipe_t *command_pipes;

        //  Synchronisation of accesses to shared thread data.
        mutex_t threads_sync;

Martin Sustrik's avatar
Martin Sustrik committed
134 135 136 137 138 139 140 141 142
        //  As pipes may reside in orphaned state in particular moments
        //  of the pipe shutdown process, i.e. neither pipe reader nor
        //  pipe writer hold reference to the pipe, we have to hold references
        //  to all pipes in dispatcher so that we can deallocate them
        //  during terminal shutdown even though it conincides with the
        //  pipe being in the orphaned state.
        typedef std::set <class pipe_t*> pipes_t;
        pipes_t pipes;

143
        //  Synchronisation of access to the pipes repository.
Martin Sustrik's avatar
Martin Sustrik committed
144 145
        mutex_t pipes_sync;

146 147 148 149 150 151 152 153 154 155 156
        //  Number of sockets alive.
        int sockets;

        //  If true, zmq_term was already called. When last socket is closed
        //  the whole 0MQ infrastructure should be deallocated.
        bool terminated;

        //  Synchronisation of access to the termination data (socket count
        //  and 'terminated' flag).
        mutex_t term_sync;

157 158 159 160 161 162 163
        //  List of inproc endpoints within this context.
        typedef std::map <std::string, class socket_base_t*> endpoints_t;
        endpoints_t endpoints;

        //  Synchronisation of access to the list of inproc endpoints.
        mutex_t endpoints_sync;

164 165
        dispatcher_t (const dispatcher_t&);
        void operator = (const dispatcher_t&);
Martin Sustrik's avatar
Martin Sustrik committed
166 167 168 169 170 171
    };
    
}

#endif