Loading...
Searching...
No Matches
queue_lockable.h
Go to the documentation of this file.
/******************************************************************************
The MIT License(MIT)
Embedded Template Library.
https://github.com/ETLCPP/etl
https://www.etlcpp.com
Copyright(c) 2019 John Wellbelove
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files(the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions :
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
******************************************************************************/
#ifndef ETL_QUEUE_LOCKABLE_INCLUDED
#define ETL_QUEUE_LOCKABLE_INCLUDED
#include "platform.h"
#include "integral_limits.h"
#include "memory.h"
#include "memory_model.h"
#include "parameter_type.h"
#include "placement_new.h"
#include "utility.h"
#include <stddef.h>
namespace etl
{
//***************************************************************************
//***************************************************************************
class queue_lockable_exception : public exception
{
public:
queue_lockable_exception(string_type reason_, string_type file_name_, numeric_type line_number_)
: exception(reason_, file_name_, line_number_)
{
}
};
//***************************************************************************
//***************************************************************************
class queue_lockable_empty : public queue_lockable_exception
{
public:
queue_lockable_empty(string_type file_name_, numeric_type line_number_)
: queue_lockable_exception(ETL_ERROR_TEXT("queue_lockable:empty", ETL_QUEUE_SPSC_LOCKABLE_FILE_ID"A"), file_name_, line_number_)
{
}
};
template <size_t VMemory_Model = etl::memory_model::MEMORY_MODEL_LARGE>
class queue_lockable_base
{
public:
typedef typename etl::size_type_lookup<VMemory_Model>::type size_type;
//*************************************************************************
//*************************************************************************
virtual ~queue_lockable_base() {}
//*************************************************************************
//*************************************************************************
size_type available_unlocked() const
{
return available_implementation();
}
//*************************************************************************
//*************************************************************************
size_type available() const
{
this->lock();
size_type result = available_implementation();
this->unlock();
return result;
}
//*************************************************************************
//*************************************************************************
bool empty_unlocked() const
{
return empty_implementation();
}
//*************************************************************************
//*************************************************************************
bool empty() const
{
this->lock();
size_type result = empty_implementation();
this->unlock();
return result;
}
//*************************************************************************
//*************************************************************************
bool full_unlocked() const
{
return full_implementation();
}
//*************************************************************************
//*************************************************************************
bool full() const
{
this->lock();
size_type result = full_implementation();
this->unlock();
return result;
}
//*************************************************************************
//*************************************************************************
size_type size_unlocked() const
{
return size_implementation();
}
//*************************************************************************
//*************************************************************************
size_type size() const
{
this->lock();
size_type result = size_implementation();
this->unlock();
return result;
}
//*************************************************************************
//*************************************************************************
size_type capacity() const
{
return Max_Size;
}
//*************************************************************************
//*************************************************************************
size_type max_size() const
{
return Max_Size;
}
protected:
queue_lockable_base(size_type max_size_)
: write_index(0)
, read_index(0)
, current_size(0)
, Max_Size(max_size_)
{
}
//*************************************************************************
//*************************************************************************
static size_type get_next_index(size_type index, size_type maximum)
{
++index;
if (index == maximum) ETL_UNLIKELY
{
index = 0;
}
return index;
}
//*************************************************************************
//*************************************************************************
virtual void lock() const = 0;
virtual void unlock() const = 0;
size_type write_index;
size_type read_index;
size_type current_size;
const size_type Max_Size;
private:
//*************************************************************************
//*************************************************************************
size_type available_implementation() const
{
return Max_Size - current_size;
}
//*************************************************************************
//*************************************************************************
bool empty_implementation() const
{
return (current_size == 0);
}
//*************************************************************************
//*************************************************************************
bool full_implementation() const
{
return (current_size == Max_Size);
}
//*************************************************************************
//*************************************************************************
size_type size_implementation() const
{
return current_size;
}
};
//***************************************************************************
//***************************************************************************
template <typename T, const size_t VMemory_Model = etl::memory_model::MEMORY_MODEL_LARGE>
class iqueue_lockable : public etl::queue_lockable_base<VMemory_Model>
{
private:
typedef queue_lockable_base<VMemory_Model> base_t;
public:
typedef T value_type;
typedef T& reference;
typedef const T& const_reference;
#if ETL_USING_CPP11
typedef T&& rvalue_reference;
#endif
typedef typename base_t::size_type size_type;
//*************************************************************************
//*************************************************************************
bool push_unlocked(const_reference value)
{
return push_implementation(value);
}
//*************************************************************************
//*************************************************************************
bool push(const_reference value)
{
this->lock();
bool result = push_implementation(value);
this->unlock();
return result;
}
#if ETL_USING_CPP11 && ETL_NOT_USING_STLPORT && !defined(ETL_QUEUE_LOCKABLE_FORCE_CPP03_IMPLEMENTATION)
//*************************************************************************
//*************************************************************************
bool push_unlocked(rvalue_reference value)
{
return push_implementation(value);
}
//*************************************************************************
//*************************************************************************
bool push(rvalue_reference value)
{
this->lock();
bool result = push_implementation(etl::move(value));
this->unlock();
return result;
}
#endif
#if ETL_USING_CPP11 && ETL_NOT_USING_STLPORT && !defined(ETL_QUEUE_LOCKABLE_FORCE_CPP03_IMPLEMENTATION)
//*************************************************************************
//*************************************************************************
template <typename... Args>
bool emplace_unlocked(Args&&... args)
{
return emplace_implementation(etl::forward<Args>(args)...);
}
//*************************************************************************
//*************************************************************************
template <typename... Args>
bool emplace(Args&&... args)
{
this->lock();
bool result = emplace_implementation(etl::forward<Args>(args)...);
this->unlock();
return result;
}
#else
//*************************************************************************
//*************************************************************************
template <typename T1>
bool emplace_unlocked(const T1& value1)
{
return emplace_implementation(value1);
}
//*************************************************************************
//*************************************************************************
template <typename T1, typename T2>
bool emplace_unlocked(const T1& value1, const T2& value2)
{
return emplace_implementation(value1, value2);
}
//*************************************************************************
//*************************************************************************
template <typename T1, typename T2, typename T3>
bool emplace_unlocked(const T1& value1, const T2& value2, const T3& value3)
{
return emplace_implementation(value1, value2, value3);
}
//*************************************************************************
//*************************************************************************
template <typename T1, typename T2, typename T3, typename T4>
bool emplace_unlocked(const T1& value1, const T2& value2, const T3& value3, const T4& value4)
{
return emplace_implementation(value1, value2, value3, value4);
}
//*************************************************************************
//*************************************************************************
bool emplace()
{
this->lock();
bool result = emplace_implementation();
this->unlock();
return result;
}
//*************************************************************************
//*************************************************************************
template <typename T1>
bool emplace(const T1& value1)
{
this->lock();
bool result = emplace_implementation(value1);
this->unlock();
return result;
}
//*************************************************************************
//*************************************************************************
template <typename T1, typename T2>
bool emplace(const T1& value1, const T2& value2)
{
this->lock();
bool result = emplace_implementation(value1, value2);
this->unlock();
return result;
}
//*************************************************************************
//*************************************************************************
template <typename T1, typename T2, typename T3>
bool emplace(const T1& value1, const T2& value2, const T3& value3)
{
this->lock();
bool result = emplace_implementation(value1, value2, value3);
this->unlock();
return result;
}
//*************************************************************************
//*************************************************************************
template <typename T1, typename T2, typename T3, typename T4>
bool emplace(const T1& value1, const T2& value2, const T3& value3, const T4& value4)
{
this->lock();
bool result = emplace_implementation(value1, value2, value3, value4);
this->unlock();
return result;
}
#endif
//*************************************************************************
//*************************************************************************
bool pop_unlocked()
{
return pop_implementation();
}
//*************************************************************************
//*************************************************************************
bool pop()
{
this->lock();
bool result = pop_implementation();
this->unlock();
return result;
}
//*************************************************************************
//*************************************************************************
bool pop_unlocked(reference value)
{
return pop_implementation(value);
}
//*************************************************************************
//*************************************************************************
bool pop(reference value)
{
this->lock();
bool result = pop_implementation(value);
this->unlock();
return result;
}
//*************************************************************************
//*************************************************************************
reference front_unlocked()
{
ETL_ASSERT_CHECK_EXTRA(!this->empty_unlocked(), ETL_ERROR(queue_lockable_empty));
return front_implementation();
}
//*************************************************************************
//*************************************************************************
const_reference front_unlocked() const
{
ETL_ASSERT_CHECK_EXTRA(!this->empty_unlocked(), ETL_ERROR(queue_lockable_empty));
return front_implementation();
}
//*************************************************************************
//*************************************************************************
reference front()
{
#if ETL_CHECKING_EXTRA
this->lock();
if (!this->empty_unlocked())
{
reference inner_result = front_implementation();
this->unlock();
return inner_result;
}
else
{
this->unlock();
ETL_ASSERT_FAIL(ETL_ERROR(queue_lockable_empty));
// fall through to return something to satisfy the compiler, even
// though this should never be reached due to undefined behaviour.
}
#endif
this->lock();
reference result = front_implementation();
this->unlock();
return result;
}
//*************************************************************************
//*************************************************************************
const_reference front() const
{
#if ETL_CHECKING_EXTRA
this->lock();
if (!this->empty_unlocked())
{
const_reference inner_result = front_implementation();
this->unlock();
return inner_result;
}
else
{
this->unlock();
ETL_ASSERT_FAIL(ETL_ERROR(queue_lockable_empty));
// fall through to return something to satisfy the compiler, even
// though this should never be reached due to undefined behaviour.
}
#endif
this->lock();
const_reference result = front_implementation();
this->unlock();
return result;
}
//*************************************************************************
//*************************************************************************
void clear_unlocked()
{
while (pop_implementation())
{
// Do nothing.
}
}
//*************************************************************************
//*************************************************************************
void clear()
{
this->lock();
if ETL_IF_CONSTEXPR (etl::is_trivially_destructible<T>::value)
{
this->write_index = 0;
this->read_index = 0;
this->current_size = 0;
}
else
{
while (pop_implementation())
{
// Do nothing.
}
}
this->unlock();
}
protected:
//*************************************************************************
//*************************************************************************
iqueue_lockable(T* p_buffer_, size_type max_size_)
: base_t(max_size_)
, p_buffer(p_buffer_)
{
}
private:
//*************************************************************************
//*************************************************************************
bool push_implementation(const_reference value)
{
if (this->current_size != this->Max_Size)
{
::new (&p_buffer[this->write_index]) T(value);
this->write_index = this->get_next_index(this->write_index, this->Max_Size);
++this->current_size;
return true;
}
// Queue is full.
return false;
}
#if ETL_USING_CPP11 && ETL_NOT_USING_STLPORT && !defined(ETL_QUEUE_LOCKABLE_FORCE_CPP03_IMPLEMENTATION)
//*************************************************************************
//*************************************************************************
bool push_implementation(rvalue_reference value)
{
if (this->current_size != this->Max_Size)
{
::new (&p_buffer[this->write_index]) T(etl::move(value));
this->write_index = this->get_next_index(this->write_index, this->Max_Size);
++this->current_size;
return true;
}
// Queue is full.
return false;
}
#endif
#if ETL_USING_CPP11 && ETL_NOT_USING_STLPORT && !defined(ETL_QUEUE_LOCKABLE_FORCE_CPP03_IMPLEMENTATION)
//*************************************************************************
//*************************************************************************
template <typename... Args>
bool emplace_implementation(Args&&... args)
{
if (this->current_size != this->Max_Size)
{
::new (&p_buffer[this->write_index]) T(etl::forward<Args>(args)...);
this->write_index = this->get_next_index(this->write_index, this->Max_Size);
++this->current_size;
return true;
}
// Queue is full.
return false;
}
#else
//*************************************************************************
//*************************************************************************
template <typename T1>
bool emplace_implementation(const T1& value1)
{
if (this->current_size != this->Max_Size)
{
::new (&p_buffer[this->write_index]) T(value1);
this->write_index = this->get_next_index(this->write_index, this->Max_Size);
++this->current_size;
return true;
}
// Queue is full.
return false;
}
//*************************************************************************
//*************************************************************************
template <typename T1, typename T2>
bool emplace_implementation(const T1& value1, const T2& value2)
{
if (this->current_size != this->Max_Size)
{
::new (&p_buffer[this->write_index]) T(value1, value2);
this->write_index = this->get_next_index(this->write_index, this->Max_Size);
++this->current_size;
return true;
}
// Queue is full.
return false;
}
//*************************************************************************
//*************************************************************************
template <typename T1, typename T2, typename T3>
bool emplace_implementation(const T1& value1, const T2& value2, const T3& value3)
{
if (this->current_size != this->Max_Size)
{
::new (&p_buffer[this->write_index]) T(value1, value2, value3);
this->write_index = this->get_next_index(this->write_index, this->Max_Size);
++this->current_size;
return true;
}
// Queue is full.
return false;
}
//*************************************************************************
//*************************************************************************
template <typename T1, typename T2, typename T3, typename T4>
bool emplace_implementation(const T1& value1, const T2& value2, const T3& value3, const T4& value4)
{
if (this->current_size != this->Max_Size)
{
::new (&p_buffer[this->write_index]) T(value1, value2, value3, value4);
this->write_index = this->get_next_index(this->write_index, this->Max_Size);
++this->current_size;
return true;
}
// Queue is full.
return false;
}
#endif
//*************************************************************************
//*************************************************************************
bool pop_implementation()
{
if (this->current_size == 0)
{
// Queue is empty
return false;
}
p_buffer[this->read_index].~T();
this->read_index = this->get_next_index(this->read_index, this->Max_Size);
--this->current_size;
return true;
}
//*************************************************************************
//*************************************************************************
bool pop_implementation(reference value)
{
if (this->current_size == 0)
{
// Queue is empty
return false;
}
#if ETL_USING_CPP11 && ETL_NOT_USING_STLPORT && !defined(ETL_QUEUE_LOCKABLE_FORCE_CPP03_IMPLEMENTATION)
value = etl::move(p_buffer[this->read_index]);
#else
value = p_buffer[this->read_index];
#endif
p_buffer[this->read_index].~T();
this->read_index = this->get_next_index(this->read_index, this->Max_Size);
--this->current_size;
return true;
}
//*************************************************************************
//*************************************************************************
reference front_implementation()
{
return p_buffer[this->read_index];
}
//*************************************************************************
//*************************************************************************
const_reference front_implementation() const
{
return p_buffer[this->read_index];
}
// Disable copy construction and assignment.
iqueue_lockable(const iqueue_lockable&) ETL_DELETE;
iqueue_lockable& operator=(const iqueue_lockable&) ETL_DELETE;
#if ETL_USING_CPP11
iqueue_lockable(iqueue_lockable&&) = delete;
iqueue_lockable& operator=(iqueue_lockable&&) = delete;
#endif
T* p_buffer;
};
//***************************************************************************
//***************************************************************************
template <typename T, size_t VSize, size_t VMemory_Model = etl::memory_model::MEMORY_MODEL_LARGE>
class queue_lockable : public etl::iqueue_lockable<T, VMemory_Model>
{
private:
typedef etl::iqueue_lockable<T, VMemory_Model> base_t;
public:
typedef typename base_t::size_type size_type;
ETL_STATIC_ASSERT((VSize <= etl::integral_limits<size_type>::max), "Size too large for memory model");
static ETL_CONSTANT size_type Max_Size = size_type(VSize);
static ETL_CONSTANT size_type Memory_Model = size_type(VMemory_Model);
//*************************************************************************
//*************************************************************************
queue_lockable()
: base_t(reinterpret_cast<T*>(buffer.raw), Max_Size)
{
}
//*************************************************************************
//*************************************************************************
~queue_lockable()
{
while (this->pop_unlocked())
{
// Do nothing.
}
}
private:
queue_lockable(const queue_lockable&) ETL_DELETE;
queue_lockable& operator=(const queue_lockable&) ETL_DELETE;
#if ETL_USING_CPP11
queue_lockable(queue_lockable&&) = delete;
queue_lockable& operator=(queue_lockable&&) = delete;
#endif
etl::uninitialized_buffer_of<T, Max_Size> buffer;
};
template <typename T, size_t VSize, size_t VMemory_Model>
ETL_CONSTANT typename queue_lockable<T, VSize, VMemory_Model>::size_type queue_lockable<T, VSize, VMemory_Model>::Max_Size;
template <typename T, size_t VSize, size_t VMemory_Model>
ETL_CONSTANT typename queue_lockable<T, VSize, VMemory_Model>::size_type queue_lockable<T, VSize, VMemory_Model>::Memory_Model;
} // namespace etl
#endif
etl::iqueue_lockable
This is the base for all queues that contain a particular type.
Definition queue_lockable.h:275
etl::iqueue_lockable::pop
bool pop(reference value)
Pop a value from the queue.
Definition queue_lockable.h:505
etl::iqueue_lockable::front_unlocked
reference front_unlocked()
Definition queue_lockable.h:521
etl::iqueue_lockable::pop_unlocked
bool pop_unlocked(reference value)
Pop a value from the queue without locking.
Definition queue_lockable.h:497
etl::iqueue_lockable::pop
bool pop()
Pop a value from the queue and discard.
Definition queue_lockable.h:483
etl::iqueue_lockable::front
reference front()
Definition queue_lockable.h:543
etl::iqueue_lockable::emplace
bool emplace(const T1 &value1, const T2 &value2, const T3 &value3, const T4 &value4)
Constructs a value in the queue 'in place'.
Definition queue_lockable.h:460
etl::iqueue_lockable::emplace
bool emplace(const T1 &value1)
Constructs a value in the queue 'in place'.
Definition queue_lockable.h:415
etl::iqueue_lockable::clear
void clear()
Clear the queue.
Definition queue_lockable.h:610
etl::iqueue_lockable::emplace_unlocked
bool emplace_unlocked(const T1 &value1, const T2 &value2, const T3 &value3)
Constructs a value in the queue 'in place'.
Definition queue_lockable.h:383
etl::iqueue_lockable::front_unlocked
const_reference front_unlocked() const
Definition queue_lockable.h:532
etl::iqueue_lockable::emplace_unlocked
bool emplace_unlocked(const T1 &value1)
Constructs a value in the queue 'in place'.
Definition queue_lockable.h:365
etl::iqueue_lockable::push_unlocked
bool push_unlocked(const_reference value)
Push a value to the queue without locking.
Definition queue_lockable.h:293
etl::iqueue_lockable::pop_unlocked
bool pop_unlocked()
Pop a value from the queue without locking, and discard.
Definition queue_lockable.h:475
etl::iqueue_lockable::emplace
bool emplace(const T1 &value1, const T2 &value2, const T3 &value3)
Constructs a value in the queue 'in place'.
Definition queue_lockable.h:445
etl::iqueue_lockable::emplace_unlocked
bool emplace_unlocked(const T1 &value1, const T2 &value2)
Constructs a value in the queue 'in place'.
Definition queue_lockable.h:374
etl::iqueue_lockable::iqueue_lockable
iqueue_lockable(T *p_buffer_, size_type max_size_)
The constructor that is called from derived classes.
Definition queue_lockable.h:636
etl::iqueue_lockable::emplace
bool emplace(const T1 &value1, const T2 &value2)
Constructs a value in the queue 'in place'.
Definition queue_lockable.h:430
etl::iqueue_lockable::size_type
base_t::size_type size_type
The type used for determining the size of the queue.
Definition queue_lockable.h:288
etl::iqueue_lockable::front
const_reference front() const
Definition queue_lockable.h:572
etl::iqueue_lockable::emplace
bool emplace()
Constructs a value in the queue 'in place'.
Definition queue_lockable.h:400
etl::iqueue_lockable::const_reference
const T & const_reference
A const reference to the type used in the queue.
Definition queue_lockable.h:284
etl::iqueue_lockable::value_type
T value_type
The type stored in the queue.
Definition queue_lockable.h:282
etl::iqueue_lockable::emplace_unlocked
bool emplace_unlocked(const T1 &value1, const T2 &value2, const T3 &value3, const T4 &value4)
Constructs a value in the queue 'in place'.
Definition queue_lockable.h:392
etl::iqueue_lockable::push
bool push(const_reference value)
Push a value to the queue.
Definition queue_lockable.h:301
etl::iqueue_lockable::clear_unlocked
void clear_unlocked()
Clear the queue, unlocked.
Definition queue_lockable.h:599
etl::iqueue_lockable::reference
T & reference
A reference to the type used in the queue.
Definition queue_lockable.h:283
etl::size_type
etl::queue_lockable_base
Definition queue_lockable.h:76
etl::queue_lockable_base::size_unlocked
size_type size_unlocked() const
Definition queue_lockable.h:160
etl::queue_lockable_base::capacity
size_type capacity() const
How many items can the queue hold.
Definition queue_lockable.h:182
etl::queue_lockable_base::max_size
size_type max_size() const
How many items can the queue hold.
Definition queue_lockable.h:190
etl::queue_lockable_base::empty
bool empty() const
Is the queue empty?
Definition queue_lockable.h:122
etl::queue_lockable_base::empty_unlocked
bool empty_unlocked() const
Definition queue_lockable.h:114
etl::queue_lockable_base< VMemory_Model >::Max_Size
const size_type Max_Size
Definition queue_lockable.h:229
etl::queue_lockable_base::read_index
size_type read_index
Where to get the oldest data.
Definition queue_lockable.h:227
etl::queue_lockable_base::current_size
size_type current_size
The current size of the queue.
Definition queue_lockable.h:228
etl::queue_lockable_base::available_unlocked
size_type available_unlocked() const
Definition queue_lockable.h:91
etl::queue_lockable_base::size_type
etl::size_type_lookup< VMemory_Model >::type size_type
The type used for determining the size of queue.
Definition queue_lockable.h:80
etl::queue_lockable_base::write_index
size_type write_index
Where to input new data.
Definition queue_lockable.h:226
etl::queue_lockable_base::get_next_index
static size_type get_next_index(size_type index, size_type maximum)
Calculate the next index.
Definition queue_lockable.h:208
etl::queue_lockable_base::size
size_type size() const
How many items in the queue?
Definition queue_lockable.h:168
etl::queue_lockable_base::lock
virtual void lock() const =0
The pure virtual lock and unlock functions.
etl::queue_lockable_base::full_unlocked
bool full_unlocked() const
Definition queue_lockable.h:137
etl::queue_lockable_base::available
size_type available() const
How much free space available in the queue.
Definition queue_lockable.h:99
etl::queue_lockable_base::full
bool full() const
Is the queue full?
Definition queue_lockable.h:145
etl::queue_lockable_base::~queue_lockable_base
virtual ~queue_lockable_base()
Destructor.
Definition queue_lockable.h:85
etl::queue_lockable
Definition queue_lockable.h:877
etl::queue_lockable::~queue_lockable
~queue_lockable()
Destructor.
Definition queue_lockable.h:903
etl::queue_lockable::queue_lockable
queue_lockable()
Default constructor.
Definition queue_lockable.h:895
etl::uninitialized_buffer_of
Definition memory.h:3153
etl::exception::exception
ETL_EXCEPTION_CONSTEXPR exception(string_type reason_, string_type, numeric_type)
Constructor.
Definition exception.h:81
etl::integral_limits
Definition integral_limits.h:517
etl::queue_lockable_empty
Definition queue_lockable.h:65
integral_limits.h
memory.h
memory_model.h
etl
Definition absolute.h:40
parameter_type.h
placement_new.h
platform.h
etl::size_type_lookup
Definition memory_model.h:50
utility.h