summaryrefslogtreecommitdiffstatshomepage
path: root/3rdparty/bx/include/bx/ringbuffer.h
diff options
context:
space:
mode:
Diffstat (limited to '3rdparty/bx/include/bx/ringbuffer.h')
-rw-r--r--3rdparty/bx/include/bx/ringbuffer.h345
1 files changed, 93 insertions, 252 deletions
diff --git a/3rdparty/bx/include/bx/ringbuffer.h b/3rdparty/bx/include/bx/ringbuffer.h
index 28e7731e3d2..fd742503072 100644
--- a/3rdparty/bx/include/bx/ringbuffer.h
+++ b/3rdparty/bx/include/bx/ringbuffer.h
@@ -12,6 +12,7 @@
namespace bx
{
+ ///
class RingBufferControl
{
BX_CLASS(RingBufferControl
@@ -20,75 +21,29 @@ namespace bx
);
public:
- RingBufferControl(uint32_t _size)
- : m_size(_size)
- , m_current(0)
- , m_write(0)
- , m_read(0)
- {
- }
-
- ~RingBufferControl()
- {
- }
-
- uint32_t available() const
- {
- return distance(m_read, m_current);
- }
-
- uint32_t consume(uint32_t _size) // consumer only
- {
- const uint32_t maxSize = distance(m_read, m_current);
- const uint32_t sizeNoSign = uint32_and(_size, 0x7fffffff);
- const uint32_t test = uint32_sub(sizeNoSign, maxSize);
- const uint32_t size = uint32_sels(test, _size, maxSize);
- const uint32_t advance = uint32_add(m_read, size);
- const uint32_t read = uint32_mod(advance, m_size);
- m_read = read;
- return size;
- }
-
- uint32_t reserve(uint32_t _size) // producer only
- {
- const uint32_t dist = distance(m_write, m_read)-1;
- const uint32_t maxSize = uint32_sels(dist, m_size-1, dist);
- const uint32_t sizeNoSign = uint32_and(_size, 0x7fffffff);
- const uint32_t test = uint32_sub(sizeNoSign, maxSize);
- const uint32_t size = uint32_sels(test, _size, maxSize);
- const uint32_t advance = uint32_add(m_write, size);
- const uint32_t write = uint32_mod(advance, m_size);
- m_write = write;
- return size;
- }
-
- uint32_t commit(uint32_t _size) // producer only
- {
- const uint32_t maxSize = distance(m_current, m_write);
- const uint32_t sizeNoSign = uint32_and(_size, 0x7fffffff);
- const uint32_t test = uint32_sub(sizeNoSign, maxSize);
- const uint32_t size = uint32_sels(test, _size, maxSize);
- const uint32_t advance = uint32_add(m_current, size);
- const uint32_t current = uint32_mod(advance, m_size);
- m_current = current;
- return size;
- }
-
- uint32_t distance(uint32_t _from, uint32_t _to) const // both
- {
- const uint32_t diff = uint32_sub(_to, _from);
- const uint32_t le = uint32_add(m_size, diff);
- const uint32_t result = uint32_sels(diff, le, diff);
-
- return result;
- }
-
- void reset()
- {
- m_current = 0;
- m_write = 0;
- m_read = 0;
- }
+ ///
+ RingBufferControl(uint32_t _size);
+
+ ///
+ ~RingBufferControl();
+
+ ///
+ uint32_t available() const;
+
+ ///
+ uint32_t consume(uint32_t _size); // consumer only
+
+ ///
+ uint32_t reserve(uint32_t _size, bool _mustSucceed = false); // producer only
+
+ ///
+ uint32_t commit(uint32_t _size); // producer only
+
+ ///
+ uint32_t distance(uint32_t _from, uint32_t _to) const; // both
+
+ ///
+ void reset();
const uint32_t m_size;
uint32_t m_current;
@@ -96,6 +51,7 @@ namespace bx
uint32_t m_read;
};
+ ///
class SpScRingBufferControl
{
BX_CLASS(SpScRingBufferControl
@@ -104,79 +60,29 @@ namespace bx
);
public:
- SpScRingBufferControl(uint32_t _size)
- : m_size(_size)
- , m_current(0)
- , m_write(0)
- , m_read(0)
- {
- }
-
- ~SpScRingBufferControl()
- {
- }
-
- uint32_t available() const
- {
- return distance(m_read, m_current);
- }
-
- uint32_t consume(uint32_t _size) // consumer only
- {
- const uint32_t maxSize = distance(m_read, m_current);
- const uint32_t sizeNoSign = uint32_and(_size, 0x7fffffff);
- const uint32_t test = uint32_sub(sizeNoSign, maxSize);
- const uint32_t size = uint32_sels(test, _size, maxSize);
- const uint32_t advance = uint32_add(m_read, size);
- const uint32_t read = uint32_mod(advance, m_size);
- m_read = read;
- return size;
- }
-
- uint32_t reserve(uint32_t _size) // producer only
- {
- const uint32_t dist = distance(m_write, m_read)-1;
- const uint32_t maxSize = uint32_sels(dist, m_size-1, dist);
- const uint32_t sizeNoSign = uint32_and(_size, 0x7fffffff);
- const uint32_t test = uint32_sub(sizeNoSign, maxSize);
- const uint32_t size = uint32_sels(test, _size, maxSize);
- const uint32_t advance = uint32_add(m_write, size);
- const uint32_t write = uint32_mod(advance, m_size);
- m_write = write;
- return size;
- }
-
- uint32_t commit(uint32_t _size) // producer only
- {
- const uint32_t maxSize = distance(m_current, m_write);
- const uint32_t sizeNoSign = uint32_and(_size, 0x7fffffff);
- const uint32_t test = uint32_sub(sizeNoSign, maxSize);
- const uint32_t size = uint32_sels(test, _size, maxSize);
- const uint32_t advance = uint32_add(m_current, size);
- const uint32_t current = uint32_mod(advance, m_size);
-
- // must commit all memory writes before moving m_current pointer
- // once m_current pointer moves data is used by consumer thread
- memoryBarrier();
- m_current = current;
- return size;
- }
-
- uint32_t distance(uint32_t _from, uint32_t _to) const // both
- {
- const uint32_t diff = uint32_sub(_to, _from);
- const uint32_t le = uint32_add(m_size, diff);
- const uint32_t result = uint32_sels(diff, le, diff);
-
- return result;
- }
-
- void reset()
- {
- m_current = 0;
- m_write = 0;
- m_read = 0;
- }
+ ///
+ SpScRingBufferControl(uint32_t _size);
+
+ ///
+ ~SpScRingBufferControl();
+
+ ///
+ uint32_t available() const;
+
+ ///
+ uint32_t consume(uint32_t _size); // consumer only
+
+ ///
+ uint32_t reserve(uint32_t _size); // producer only
+
+ ///
+ uint32_t commit(uint32_t _size); // producer only
+
+ ///
+ uint32_t distance(uint32_t _from, uint32_t _to) const; // both
+
+ ///
+ void reset();
const uint32_t m_size;
uint32_t m_current;
@@ -184,7 +90,8 @@ namespace bx
uint32_t m_read;
};
- template <typename Control>
+ ///
+ template <typename ControlT>
class ReadRingBufferT
{
BX_CLASS(ReadRingBufferT
@@ -194,65 +101,40 @@ namespace bx
);
public:
- ReadRingBufferT(Control& _control, const char* _buffer, uint32_t _size)
- : m_control(_control)
- , m_read(_control.m_read)
- , m_end(m_read+_size)
- , m_size(_size)
- , m_buffer(_buffer)
- {
- BX_CHECK(_control.available() >= _size, "%d >= %d", _control.available(), _size);
- }
-
- ~ReadRingBufferT()
- {
- }
-
- void end()
- {
- m_control.consume(m_size);
- }
-
- void read(char* _data, uint32_t _len)
- {
- const uint32_t eof = (m_read + _len) % m_control.m_size;
- uint32_t wrap = 0;
- const char* from = &m_buffer[m_read];
-
- if (eof < m_read)
- {
- wrap = m_control.m_size - m_read;
- memcpy(_data, from, wrap);
- _data += wrap;
- from = (const char*)&m_buffer[0];
- }
-
- memcpy(_data, from, _len-wrap);
-
- m_read = eof;
- }
-
- void skip(uint32_t _len)
- {
- m_read += _len;
- m_read %= m_control.m_size;
- }
+ ///
+ ReadRingBufferT(ControlT& _control, const char* _buffer, uint32_t _size);
+
+ ///
+ ~ReadRingBufferT();
+
+ ///
+ void end();
+
+ ///
+ void read(char* _data, uint32_t _len);
+
+ ///
+ void skip(uint32_t _len);
private:
template <typename Ty>
friend class WriteRingBufferT;
- Control& m_control;
+ ControlT& m_control;
uint32_t m_read;
uint32_t m_end;
const uint32_t m_size;
const char* m_buffer;
};
+ ///
typedef ReadRingBufferT<RingBufferControl> ReadRingBuffer;
+
+ ///
typedef ReadRingBufferT<SpScRingBufferControl> SpScReadRingBuffer;
- template <typename Control>
+ ///
+ template <typename ControlT>
class WriteRingBufferT
{
BX_CLASS(WriteRingBufferT
@@ -262,81 +144,40 @@ namespace bx
);
public:
- WriteRingBufferT(Control& _control, char* _buffer, uint32_t _size)
- : m_control(_control)
- , m_size(_size)
- , m_buffer(_buffer)
- {
- uint32_t size = m_control.reserve(_size);
- BX_UNUSED(size);
- BX_CHECK(size == _size, "%d == %d", size, _size);
- m_write = m_control.m_current;
- m_end = m_write+_size;
- }
-
- ~WriteRingBufferT()
- {
- }
-
- void end()
- {
- m_control.commit(m_size);
- }
-
- void write(const char* _data, uint32_t _len)
- {
- const uint32_t eof = (m_write + _len) % m_control.m_size;
- uint32_t wrap = 0;
- char* to = &m_buffer[m_write];
-
- if (eof < m_write)
- {
- wrap = m_control.m_size - m_write;
- memcpy(to, _data, wrap);
- _data += wrap;
- to = (char*)&m_buffer[0];
- }
-
- memcpy(to, _data, _len-wrap);
-
- m_write = eof;
- }
-
- void write(ReadRingBufferT<Control>& _read, uint32_t _len)
- {
- const uint32_t eof = (_read.m_read + _len) % _read.m_control.m_size;
- uint32_t wrap = 0;
- const char* from = &_read.m_buffer[_read.m_read];
-
- if (eof < _read.m_read)
- {
- wrap = _read.m_control.m_size - _read.m_read;
- write(from, wrap);
- from = (const char*)&_read.m_buffer[0];
- }
-
- write(from, _len-wrap);
-
- _read.m_read = eof;
- }
-
- void skip(uint32_t _len)
- {
- m_write += _len;
- m_write %= m_control.m_size;
- }
+ ///
+ WriteRingBufferT(ControlT& _control, char* _buffer, uint32_t _size);
+
+ ///
+ ~WriteRingBufferT();
+
+ ///
+ void end();
+
+ ///
+ void write(const char* _data, uint32_t _len);
+
+ ///
+ void write(ReadRingBufferT<ControlT>& _read, uint32_t _len);
+
+ ///
+ void skip(uint32_t _len);
private:
- Control& m_control;
+ ControlT& m_control;
uint32_t m_write;
uint32_t m_end;
const uint32_t m_size;
char* m_buffer;
};
+ ///
typedef WriteRingBufferT<RingBufferControl> WriteRingBuffer;
+
+ ///
typedef WriteRingBufferT<SpScRingBufferControl> SpScWriteRingBuffer;
} // namespace bx
+#include "inline/ringbuffer.inl"
+
#endif // BX_RINGBUFFER_H_HEADER_GUARD