ffer的概念在RingBuffer中经常遇到一个Buffer满和Buffer空的判断的问题一般的做法是留一个单位的buffer不用这样做最省事但是当RingBuffer单位是一个结构体时这个浪费就不能接受了市面上大多数解决办法是镜像指示位办法但是具体实现上又有各种设计但是并不是满足的开发需要所以有本项目。

本项目地址bobwenstudy/simple_ringbuffer:

一种基于镜像指示位办法的RingBuffer实现解决Mirror和2的幂个数限制

(wikipedia.org)ring

类别simple_ringbufferkfifo(linux)ringbuffer

(rt-thread)需要mirror位多进程风险否否是需要个数为2的幂否是否支持结构体成员是是linux5.7否

mirror位

多了Mirror位就会有一个多进程操作的风险除非Mirror位和数值同时写入。

所以最好不要有Mirror位。

Linux的kfifo解决了Mirror位的问题因为其用到了uint32_t回环的特性需要个数为2个幂。

虽然这样大大减少了算法工作量也可以用位运算来优化取余预算的计算效率。

但是使用起来多少不是很舒适尤其设计到对结构体成员操作时一不注意又要浪费Buffer。

支持结构体成员

其实如果RingBuffer成员的单位为1个字节的话其实没必要在乎1个字节的损失只是使用时需要多申请1个字节多少看起来不是很清爽。

但是当RingBuffer的成员的单位为很大的值时1个成员的损失才至关重要。

现有的项目考虑灵活性RingBuffer需要支持各种字节操作效率并不高本项目针对结构体操作需要专门设计了Data_RingBuffer工具来对多字节场景进行处理操作效率更高并提供了2种操作接口以满足不同业务操作的需要。

镜像指示位-本项目实现

本项目不想有Mirror的操作问题也不想有个数2的幂的限制。

处理上做了一些特殊的处理严格区分index和ptr的概念。

index的取值范围为[0~2n-1]并不像Linux取到最大值解决了个数2的幂的限制。

write_index

write_index;其中ptr的获取考虑效率使用减法不使用取余运算。

#define

RINGBUFFER_INDEX_TO_PTR(_index,

_total_size)

RINGBUFFER_INDEX_TO_PTR(ringbuf-write_index,

代码结构如下所示

simple_ringbufferRingbuffer实现包含结构体操作实现simple_data_ringbuffer和缓冲池操作实现simple_data_ringbuffer。

test_0.c和test_1.c和test_2.c测试例程。

main.c测试例程。

build.mk和MakefileMakefile编译环境。

README.md说明文档

simple_ringbuffer├──

SIMPLE_RINGBUFFER_DEFINE(test_ringbuf,

0x100);//

simple_ringbuffer_put(test_ringbuf,

data,

simple_ringbuffer_get(test_ringbuf,

rdata,

使用提供simple_data_ringbuffer.h接口操作即可。

提供了两种接口按需使用。

struct

SIMPLE_DATA_RINGBUFFER_DEFINE(test_ringbuf,

0x100,

simple_ringbuffer_put(test_ringbuf,

data);//

simple_ringbuffer_get(test_ringbuf,

rdata);//

simple_data_ringbuffer_enqueue_get(test_ringbuf,

(void

getsimple_data_ringbuffer_enqueue(test_ringbuf,

index);

simple_data_ringbuffer_dequeue_peek(test_ringbuf);

dequeue

peeksimple_data_ringbuffer_dequeue(test_ringbuf);

real

ringbuffer必须先入先出在部分不是先入先出场景下又想用RingBuffer读写线程独立的特性本项目提供了一个简易数据缓存池实现方案通过只保存数据指针的方式来实现非先入先出的数据缓冲池。

其结构体如下。

simple_pool_t用于缓冲池管理由于RingBuffer存储的是指针所以需要通过item_size记录每个成员的实际大小。

定义一个Pool时需要指针数组_name##_fifo_storage[_num]其用于存储实际存放数据的指针用RingBuffer管理。

真实存数据的区域为_name##_data_storage[_num][MROUND(_data_size)]。

typedef

_name##_data_storage[_num][MROUND(_data_size)];使用操作如下

struct

Space在线编译如果不想搭建环境可以直接CodeSpace编译。

Windows编译

GCC环境笔者用的msys64mingw用于编译生成exe参考这个文章安装即可。

Win7下msys64安装mingw工具链

Milton

本项目都是由makefile组织编译的编译整个项目只需要执行make

make

run即可运行例程例程中实现了上述文档说明的问题和API的基本测试。

D:\workspace\github\simple_ringbuffer

make

..........................................................

pass

...................................................

pass

..................................................

pass

.....................................................

pass

..............................................

pass

test_work_read_index_big_to_write_index

pass

test_work_read_index_big_to_write_index

pass

......................................................

pass

...............................................

pass

..............................................

pass

.................................................

pass

test_work_read_index_big_to_write_index_odd

pass

.....................................................

pass

................................................

pass

.........................................

pass

test_data_work_full_define_enqueue

.................................

pass

.................................................

pass

............................................

pass