Embedded Multicore Building Blocks V1.0.0
wait_free_spsc_queue.h
1 /*
2  * Copyright (c) 2014-2017, Siemens AG. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
18  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24  * POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #ifndef EMBB_CONTAINERS_WAIT_FREE_SPSC_QUEUE_H_
28 #define EMBB_CONTAINERS_WAIT_FREE_SPSC_QUEUE_H_
29 
30 #include <embb/base/atomic.h>
31 
32 #include <iostream>
33 #include <stdexcept>
34 #include <stdlib.h>
35 #include <vector>
106 namespace embb {
107 namespace containers {
120 template<typename Type, class Allocator = embb::base::Allocator< Type > >
122  private:
126  Allocator allocator;
127 
131  size_t capacity;
132 
136  Type* queue_array;
137 
141  embb::base::Atomic<size_t> head_index;
142 
146  embb::base::Atomic<size_t> tail_index;
147 
151  static size_t AlignCapacityToPowerOfTwo(size_t capacity);
152 
153  public:
165  size_t capacity
167  );
168 
175 
183  size_t GetCapacity();
184 
198  bool TryEnqueue(
199  Type const & element
201  );
202 
216  bool TryDequeue(
217  Type & element
220  );
221 };
222 } // namespace containers
223 } // namespace embb
224 
225 #include<embb/containers/internal/wait_free_spsc_queue-inl.h>
226 
227 #endif // EMBB_CONTAINERS_WAIT_FREE_SPSC_QUEUE_H_
Definition: lock_free_mpmc_queue.h:40
~WaitFreeSPSCQueue()
Destroys the queue.
Wait-free queue for a single producer and a single consumer.
Definition: wait_free_spsc_queue.h:121
size_t GetCapacity()
Returns the capacity of the queue.
bool TryEnqueue(Type const &element)
Tries to enqueue an element into the queue.
bool TryDequeue(Type &element)
Tries to dequeue an element from the queue.
WaitFreeSPSCQueue(size_t capacity)
Creates a queue with at least the specified capacity.