yqueue.hpp 7.65 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_YQUEUE_HPP_INCLUDED__
#define __ZMQ_YQUEUE_HPP_INCLUDED__
Martin Sustrik's avatar
Martin Sustrik committed
32

33
#include <stdlib.h>
Martin Sustrik's avatar
Martin Sustrik committed
34 35 36
#include <stddef.h>

#include "err.hpp"
37
#include "atomic_ptr.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
38

Martin Sustrik's avatar
Martin Sustrik committed
39
namespace zmq
Martin Sustrik's avatar
Martin Sustrik committed
40 41 42 43 44 45
{

    //  yqueue is an efficient queue implementation. The main goal is
    //  to minimise number of allocations/deallocations needed. Thus yqueue
    //  allocates/deallocates elements in batches of N.
    //
46
    //  yqueue allows one thread to use push/back function and another one
Martin Sustrik's avatar
Martin Sustrik committed
47 48 49 50
    //  to use pop/front functions. However, user must ensure that there's no
    //  pop on the empty queue and that both threads don't access the same
    //  element in unsynchronised manner.
    //
51
    //  T is the type of the object in the queue.
Martin Sustrik's avatar
Martin Sustrik committed
52
    //  N is granularity of the queue (how many pushes have to be done till
53
    //  actual memory allocation is required).
54 55 56 57 58 59 60 61
#ifdef HAVE_POSIX_MEMALIGN
    // ALIGN is the memory alignment size to use in the case where we have
    // posix_memalign available. Default value is 64, this alignment will
    // prevent two queue chunks from occupying the same CPU cache line on
    // architectures where cache lines are <= 64 bytes (e.g. most things
    // except POWER).
    template <typename T, int N, size_t ALIGN = 64> class yqueue_t
#else
Martin Sustrik's avatar
Martin Sustrik committed
62
    template <typename T, int N> class yqueue_t
63
#endif
Martin Sustrik's avatar
Martin Sustrik committed
64 65 66 67 68 69
    {
    public:

        //  Create the queue.
        inline yqueue_t ()
        {
70
             begin_chunk = allocate_chunk();
71
             alloc_assert (begin_chunk);
Martin Sustrik's avatar
Martin Sustrik committed
72 73 74 75 76 77 78 79 80 81 82
             begin_pos = 0;
             back_chunk = NULL;
             back_pos = 0;
             end_chunk = begin_chunk;
             end_pos = 0;
        }

        //  Destroy the queue.
        inline ~yqueue_t ()
        {
            while (true) {
83
                if (begin_chunk == end_chunk) {
84
                    free (begin_chunk);
85
                    break;
86
                }
Martin Sustrik's avatar
Martin Sustrik committed
87 88
                chunk_t *o = begin_chunk;
                begin_chunk = begin_chunk->next;
89
                free (o);
Martin Sustrik's avatar
Martin Sustrik committed
90
            }
91 92

            chunk_t *sc = spare_chunk.xchg (NULL);
93
            free (sc);
Martin Sustrik's avatar
Martin Sustrik committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
        }

        //  Returns reference to the front element of the queue.
        //  If the queue is empty, behaviour is undefined.
        inline T &front ()
        {
             return begin_chunk->values [begin_pos];
        }

        //  Returns reference to the back element of the queue.
        //  If the queue is empty, behaviour is undefined.
        inline T &back ()
        {
            return back_chunk->values [back_pos];
        }

        //  Adds an element to the back end of the queue.
        inline void push ()
        {
            back_chunk = end_chunk;
            back_pos = end_pos;

Martin Sustrik's avatar
Martin Sustrik committed
116
            if (++end_pos != N)
Martin Sustrik's avatar
Martin Sustrik committed
117 118
                return;

119 120 121
            chunk_t *sc = spare_chunk.xchg (NULL);
            if (sc) {
                end_chunk->next = sc;
122
                sc->prev = end_chunk;
123
            } else {
124
                end_chunk->next = allocate_chunk();
125
                alloc_assert (end_chunk->next);
126
                end_chunk->next->prev = end_chunk;
127
            }
Martin Sustrik's avatar
Martin Sustrik committed
128 129 130 131
            end_chunk = end_chunk->next;
            end_pos = 0;
        }

132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
        //  Removes element from the back end of the queue. In other words
        //  it rollbacks last push to the queue. Take care: Caller is
        //  responsible for destroying the object being unpushed.
        //  The caller must also guarantee that the queue isn't empty when
        //  unpush is called. It cannot be done automatically as the read
        //  side of the queue can be managed by different, completely
        //  unsynchronised thread.
        inline void unpush ()
        {
            //  First, move 'back' one position backwards.
            if (back_pos)
                --back_pos;
            else {
                back_pos = N - 1;
                back_chunk = back_chunk->prev;
            }

            //  Now, move 'end' position backwards. Note that obsolete end chunk
            //  is not used as a spare chunk. The analysis shows that doing so
            //  would require free and atomic operation per chunk deallocated
            //  instead of a simple free.
            if (end_pos)
                --end_pos;
            else {
                end_pos = N - 1;
                end_chunk = end_chunk->prev;
                free (end_chunk->next);
                end_chunk->next = NULL;
            }
        }

Martin Sustrik's avatar
Martin Sustrik committed
163 164 165 166 167 168
        //  Removes an element from the front end of the queue.
        inline void pop ()
        {
            if (++ begin_pos == N) {
                chunk_t *o = begin_chunk;
                begin_chunk = begin_chunk->next;
169
                begin_chunk->prev = NULL;
Martin Sustrik's avatar
Martin Sustrik committed
170
                begin_pos = 0;
171 172 173 174 175

                //  'o' has been more recently used than spare_chunk,
                //  so for cache reasons we'll get rid of the spare and
                //  use 'o' as the spare.
                chunk_t *cs = spare_chunk.xchg (o);
176
                free (cs);
Martin Sustrik's avatar
Martin Sustrik committed
177 178 179 180 181 182 183 184 185
            }
        }

    private:

        //  Individual memory chunk to hold N elements.
        struct chunk_t
        {
             T values [N];
186
             chunk_t *prev;
Martin Sustrik's avatar
Martin Sustrik committed
187 188 189
             chunk_t *next;
        };

190 191 192 193 194 195 196 197 198 199 200 201
        inline chunk_t *allocate_chunk ()
        {
#ifdef HAVE_POSIX_MEMALIGN
                void *pv;
                if (posix_memalign(&pv, ALIGN, sizeof (chunk_t)) == 0)
                    return (chunk_t*) pv;
                return NULL;
#else
                return (chunk_t*) malloc (sizeof (chunk_t));
#endif
        }

Martin Sustrik's avatar
Martin Sustrik committed
202 203 204 205 206 207 208 209 210 211 212
        //  Back position may point to invalid memory if the queue is empty,
        //  while begin & end positions are always valid. Begin position is
        //  accessed exclusively be queue reader (front/pop), while back and
        //  end positions are accessed exclusively by queue writer (back/push).
        chunk_t *begin_chunk;
        int begin_pos;
        chunk_t *back_chunk;
        int back_pos;
        chunk_t *end_chunk;
        int end_pos;

213 214
        //  People are likely to produce and consume at similar rates.  In
        //  this scenario holding onto the most recently freed chunk saves
215
        //  us from having to call malloc/free.
216 217
        atomic_ptr_t<chunk_t> spare_chunk;

Martin Sustrik's avatar
Martin Sustrik committed
218 219
        //  Disable copying of yqueue.
        yqueue_t (const yqueue_t&);
220
        const yqueue_t &operator = (const yqueue_t&);
Martin Sustrik's avatar
Martin Sustrik committed
221 222 223 224 225
    };

}

#endif