ypipe.hpp 7.13 KB
Newer Older
Martin Sustrik's avatar
Martin Sustrik committed
1
/*
2
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
Martin Sustrik's avatar
Martin Sustrik committed
3

4
    This file is part of libzmq, the ZeroMQ core engine in C++.
Martin Sustrik's avatar
Martin Sustrik committed
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
Martin Sustrik's avatar
Martin Sustrik committed
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.
Martin Sustrik's avatar
Martin Sustrik committed
25

26
    You should have received a copy of the GNU Lesser General Public License
Martin Sustrik's avatar
Martin Sustrik committed
27 28 29
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

Martin Sustrik's avatar
Martin Sustrik committed
30 31
#ifndef __ZMQ_YPIPE_HPP_INCLUDED__
#define __ZMQ_YPIPE_HPP_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
32 33 34

#include "atomic_ptr.hpp"
#include "yqueue.hpp"
35
#include "ypipe_base.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
36

Martin Sustrik's avatar
Martin Sustrik committed
37
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
38
{
39 40 41 42 43 44 45 46 47 48 49 50
//  Lock-free queue implementation.
//  Only a single thread can read from the pipe at any specific moment.
//  Only a single thread can write to the pipe at any specific moment.
//  T is the type of the object in the queue.
//  N is granularity of the pipe, i.e. how many items are needed to
//  perform next memory allocation.

template <typename T, int N> class ypipe_t : public ypipe_base_t<T>
{
  public:
    //  Initialises the pipe.
    inline ypipe_t ()
Martin Sustrik's avatar
Martin Sustrik committed
51
    {
52
        //  Insert terminator element into the queue.
53
        _queue.push ();
Martin Sustrik's avatar
Martin Sustrik committed
54

55 56
        //  Let all the pointers to point to the terminator.
        //  (unless pipe is dead, in which case c is set to NULL).
57 58
        _r = _w = _f = &_queue.back ();
        _c.set (&_queue.back ());
59 60 61 62 63
    }

    //  The destructor doesn't have to be virtual. It is made virtual
    //  just to keep ICC and code checking tools from complaining.
    inline virtual ~ypipe_t () {}
64

65 66 67
        //  Following function (write) deliberately copies uninitialised data
        //  when used with zmq_msg. Initialising the VSM body for
        //  non-VSM messages won't be good for performance.
Martin Sustrik's avatar
Martin Sustrik committed
68 69 70 71 72 73

#ifdef ZMQ_HAVE_OPENVMS
#pragma message save
#pragma message disable(UNINIT)
#endif

74 75 76 77 78 79 80
    //  Write an item to the pipe.  Don't flush it yet. If incomplete is
    //  set to true the item is assumed to be continued by items
    //  subsequently written to the pipe. Incomplete items are never
    //  flushed down the stream.
    inline void write (const T &value_, bool incomplete_)
    {
        //  Place the value to the queue, add new terminator element.
81 82
        _queue.back () = value_;
        _queue.push ();
83 84 85

        //  Move the "flush up to here" poiter.
        if (!incomplete_)
86
            _f = &_queue.back ();
87
    }
Martin Sustrik's avatar
Martin Sustrik committed
88 89 90 91 92

#ifdef ZMQ_HAVE_OPENVMS
#pragma message restore
#endif

93 94 95 96
    //  Pop an incomplete item from the pipe. Returns true if such
    //  item exists, false otherwise.
    inline bool unwrite (T *value_)
    {
97
        if (_f == &_queue.back ())
98
            return false;
99 100
        _queue.unpush ();
        *value_ = _queue.back ();
101 102 103 104 105 106 107 108 109
        return true;
    }

    //  Flush all the completed items into the pipe. Returns false if
    //  the reader thread is sleeping. In that case, caller is obliged to
    //  wake the reader up before using the pipe again.
    inline bool flush ()
    {
        //  If there are no un-flushed items, do nothing.
110
        if (_w == _f)
111 112
            return true;

113
        //  Try to set 'c' to 'f'.
114
        if (_c.cas (_w, _f) != _w) {
115 116 117 118 119
            //  Compare-and-swap was unseccessful because 'c' is NULL.
            //  This means that the reader is asleep. Therefore we don't
            //  care about thread-safeness and update c in non-atomic
            //  manner. We'll return false to let the caller know
            //  that reader is sleeping.
120 121
            _c.set (_f);
            _w = _f;
122
            return false;
Martin Sustrik's avatar
Martin Sustrik committed
123 124
        }

125 126
        //  Reader is alive. Nothing special to do now. Just move
        //  the 'first un-flushed item' pointer to 'f'.
127
        _w = _f;
128 129
        return true;
    }
130

131 132 133 134
    //  Check whether item is available for reading.
    inline bool check_read ()
    {
        //  Was the value prefetched already? If so, return.
135
        if (&_queue.front () != _r && _r)
Martin Sustrik's avatar
Martin Sustrik committed
136 137
            return true;

138 139 140 141
        //  There's no prefetched value, so let us prefetch more values.
        //  Prefetching is to simply retrieve the
        //  pointer from c in atomic fashion. If there are no
        //  items to prefetch, set c to NULL (using compare-and-swap).
142
        _r = _c.cas (&_queue.front (), NULL);
143 144 145 146 147

        //  If there are no elements prefetched, exit.
        //  During pipe's lifetime r should never be NULL, however,
        //  it can happen during pipe shutdown when items
        //  are being deallocated.
148
        if (&_queue.front () == _r || !_r)
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
            return false;

        //  There was at least one value prefetched.
        return true;
    }

    //  Reads an item from the pipe. Returns false if there is no value.
    //  available.
    inline bool read (T *value_)
    {
        //  Try to prefetch a value.
        if (!check_read ())
            return false;

        //  There was at least one value prefetched.
        //  Return it to the caller.
165 166
        *value_ = _queue.front ();
        _queue.pop ();
167 168 169 170 171 172
        return true;
    }

    //  Applies the function fn to the first elemenent in the pipe
    //  and returns the value returned by the fn.
    //  The pipe mustn't be empty or the function crashes.
173
    inline bool probe (bool (*fn_) (const T &))
174 175 176 177
    {
        bool rc = check_read ();
        zmq_assert (rc);

178
        return (*fn_) (_queue.front ());
179 180 181 182 183 184 185
    }

  protected:
    //  Allocation-efficient queue to store pipe items.
    //  Front of the queue points to the first prefetched item, back of
    //  the pipe points to last un-flushed item. Front is used only by
    //  reader thread, while back is used only by writer thread.
186
    yqueue_t<T, N> _queue;
187 188 189

    //  Points to the first un-flushed item. This variable is used
    //  exclusively by writer thread.
190
    T *_w;
191 192 193

    //  Points to the first un-prefetched item. This variable is used
    //  exclusively by reader thread.
194
    T *_r;
195 196

    //  Points to the first item to be flushed in the future.
197
    T *_f;
198 199 200 201 202

    //  The single point of contention between writer and reader thread.
    //  Points past the last flushed item. If it is NULL,
    //  reader is asleep. This pointer should be always accessed using
    //  atomic operations.
203
    atomic_ptr_t<T> _c;
204 205 206 207 208

    //  Disable copying of ypipe object.
    ypipe_t (const ypipe_t &);
    const ypipe_t &operator= (const ypipe_t &);
};
Martin Sustrik's avatar
Martin Sustrik committed
209 210 211
}

#endif