环形数组以及高效环形数组的qt实现

环形数组是一种实现循环缓冲区的数据结构。

它有以下主要特征:

1. 数组首尾相连,形成一个环形。当追加数据超出数组尾部时,会从头部继续追加,形成循环。

2. 使用两个指针来表示环形数组中数据的首尾,分别是head指针和tail指针。

3. head指针指向环形数组的首部数据,tail指针指向环形数组的尾部数据。

4. 数组中从head指针到tail指针的数据是有效数据,其余为空闲空间。

5. 当head == tail时,表示环形数组为空。当tail + 1 == head时,表示环形数组已满。

6. 添加数据时,将数据写入tail指针位置,然后tail指针移动。如果超出数组尾部,tail指针会循环到头部。

7. 取出数据时,从head指针位置取数据,然后head指针移动。如果超出数组尾部,head指针会循环到头部。

8. 由于head和tail的移动是循环的,因此可以一直追加和取出数据,实现循环利用数组空间。环形数组通常用来实现循环队列或缓冲区,优势是不需要移动大量数据就可以进行队首和队尾的添加与删除操作。但需要注意防止队满和队空的情况。

下图展示了环形数组的结构及添加删除数据的过程:

spdlog使用环形数组实现其lock-free日志缓冲区,主要原因是:

1. 可以高效并发地进行读写操作,没有锁竞争,性能很高。

2. 写入新日志不需要移动老日志,操作简单快速。

3. 当缓冲区满时,新日志会覆盖老日志,实现了自动限流和重复日志抑制。

4. 读出日志简单快速,直接读取head指针位置数据即可。

5. 结构简单,没有额外内存分配,总容量固定,性能预期更加稳定。

所以,环形数组是实现高性能循环缓冲区或队列的一种非常理想的结构,这也是spdlog选用它来实现日志缓冲的主要原因。通过这种 lock-free 结构,spdlog可以高效并安全地实现用户线程和后台线程之间的日志交换。

使用Qt实现的环形数组

cpp
#include <QVector>

template <typename T>
class RingBuffer
{
public:
    RingBuffer(int size)
        : m_size(size)
        , m_head(0)
        , m_tail(0)
        , m_buffer(size)
    {
    }

    void append(const T& value)
    {
        m_buffer[m_tail] = value;
        m_tail = (m_tail + 1) % m_size;
        if (m_tail == m_head) {
            m_head = (m_head + 1) % m_size;  // overflow, remove the head element
        }
    }

    T next()
    {
        if (m_head != m_tail) {
            T value = m_buffer[m_head];
            m_head = (m_head + 1) % m_size;
            return value;
        }
        return T();       // empty
    }

    bool isEmpty() const { return m_head == m_tail; }
    bool isFull()  const { return (m_tail + 1) % m_size == m_head; }

private:
    int m_size;
    int m_head;
    int m_tail;
    QVector<T> m_buffer;
};

int main() 
{
    RingBuffer<int> ring(5);
    
    ring.append(1);
    ring.append(2);
    ring.append(3);
    ring.append(4);
    
    qDebug() << ring.next();  // 1
    qDebug() << ring.next();  // 2
    
    ring.append(5);   // overflow, remove the head element 1
    
    qDebug() << ring.next();  // 3 
    qDebug() << ring.next();  // 4
    qDebug() << ring.next();  // 5
    
    qDebug() << ring.isEmpty(); // true
    
    return 0;
}

这个示例实现了一个模板环形数组RingBuffer,可以存储任意类型的数据。它主要功能为:

1. 在尾部append()添加数据,如果超出数组长度会覆盖头部数据;

2. 从头部next()取出数据;

3. isEmpty()判断是否为空;

4. isFull()判断是否已满;

5. 使用m_head和m_tail指针来表示头尾位置,并进行循环移动;

6. 当头尾指针相遇时为空,尾指针+1等于头指针时为满。

该示例演示了环形数组的主要结构与功能,可以高效地进行循环添加与删除操作。这种结构非常适合实现各种缓冲区或队列,也是spdlog选择它来设计日志缓冲区的主要原因。

Qt的QVector被用来实现底层的数组存储,简洁高效。整个实现仅有少量代码,而具备较强的扩展性和通用性。