文章目录
1. ringbuffer简单介绍
环形缓冲区(ringbuffer),实际上就是一种队列数据结构,只不过它不是线性队列,而是环形队列。
关于环形缓冲区(ringbuffer)的详细介绍,网上一搜一大把,这里不重复介绍了,我这里直接上代码。
详细介绍可以参考下面链接里面的介绍:
- https://en.wikipedia.org/wiki/Circular_buffer 介绍环形缓冲区的一个网站,写的非常详细。
- 环形缓冲区(Ring Buffer)使用说明
2. ringbuffer的代码实现
实现环形缓冲区的形式有使用数组的,也可以使用链表。我这里为了实现简单,就用数组作为 ringbuffer 的内存来实现。
在实现 ringbuffer 时,要有两个指针,读指针和写指针。每当向 ringbuffer 中写入一个数据时,写指针加1;同理从 ringbuffer 中读取一个数据时,读指针加1。
对于 ringbuffer 的读写操作,我们有几个重点问题需要考虑:
-
读写指针移动到 ringbuffer 的最大长度之后,如何返回首位置?
对于 ringbuffer 的读写指针位置的计算,精髓就在于对读写指针进行取模运算。即当读写指针移动一个位置时,然后对 ringbuffer 的大小进行取模运算,这样当读写指针移动到最末尾时,取模运算的结果就是 0,即返回的 ringbuffer 的首位置了。代码表示如下:
write_index : 当前写位置 read_index : 当前读位置 ringbuffer_size : ringbuffer 缓冲区的大小 /* 读写指针每移动一个位置,都对 ringbuffer 大小进行取模运算 */ write_index = (write_index + 1) % ringbuffer_size read_index = (read_index + 1) % ringbuffer_size
-
如何判断 ringbuffer 为空?
读写指针的位置相等时,说明 ringbuffer 为空。
write_index == read_index
-
如何判断 ringbuffer 为满?
当写指针的下一个位置等于读指针的位置时,那么 ringbuffer 为满。
(write_index + 1) % ringbuffer_size == read_index
2.1 ringbuffer数据结构定义
ringbuffer 的数据结构封装如下,主要成员有读写指针,还有指向用户提供 buffer 的指针和 buffer 的大小。
其中,读写指针的这两个成员,很可能会因为外部一些原因(比如串口中断)造成读写位置的变化,而这个变化编译器很可能不知道,所以为了防止编译器优化而加上 volatile
关键字修饰。
typedef struct _ringbuffer_t
{
volatile unsigned int read_index; /* 当前读位置 */
volatile unsigned int write_index; /* 当前写位置 */
unsigned int buffer_size; /* ringbuffer大小 */
unsigned char *buffer_ptr; /* 指向ringbuffer */
} ringbuffer_t;
2.2 ringbuffer初始化
/*
* 函数作用 : 初始化ringbuffer结构体(句柄)
* 参数 rb : 指向ringbuffer句柄
* 参数 pool : 指向ringbuffer缓冲区,用户调用时一般提供一个数组
* 参数 size : 缓冲区的大小
* 返回值