rt_ringbuffer_peak疑问

发布于 2022-05-26 16:03:37 浏览：920 订阅该版

lchnu 2022-05-26

Witness, Understand, Skill

peak函数只读取rb，但不取数据，所以read_index不动。

这个函数使用场合很少，`用于返回rb中第一个有效（可读）数据的地址，所以第二个形参是一个二级指针。`

**慎用**。除非你的需求是: rb中有n个有效数据时，仅仅取出第一个可读数据的场合。`并且建议单字节访问`，因为rb本质上是用一段连续地址空间做循环，用这个接口，返回地址，一个不小心就越界了。

**编辑帖子，补充说明，我的上述回复是错误的。**

我深入看了一下代码，对peak函数的说明也有疑惑。

https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/programming-manual/device-ipc/ringbuffer/ringbuffer?id=ringbuffer-%e6%8e%a5%e5%8f%a3%e4%bb%8b%e7%bb%8d

官方文档提到：

> 从 ringbuffer 里读取数据的接口分为两类，一类是读数据并取出数据，另一类是读数据但并不取出数据（peak 操作）。

从代码中看，对read_index进行了写操作。毫无疑问，对于ringbuffer的内部逻辑而言，使用peak之后，数据是取出了的。

**我的结论：官方文档中，对于这个peak函数的说明是错的。**

`由于其他楼层放图不方便，2022-05-27 根据lz的新问题，继续更新：`

> 不好意思我没表达清楚，我是想问为什么上面有rb->read_index += size;下面就rb->read_index = 0;了

![5b0cd05eafa51f3099bec37f4bdfef4d.png.webp](https://oss-club.rt-thread.org/uploads/20220527/5b0cd05eafa51f3099bec37f4bdfef4d.png.webp)

我的观点是：
1. 官方代码中，当bufsize - readindex >= size时，表示，从readindex到数组末尾有数据。**只取出从readindex到数组末尾的数据，如图所示。**

2. 你认为应该将readindex = 0 修改为 readindex = writeindex。那就是取出所有数据，**这个观点我也认同。**

3. **我一直在强调，这个函数的作用与官方文档描述不符合**，既然是错的，纠结readindex是到0，还是到writeindex，有什么意义呢？怎么处理readindex都无所谓了，只是表示程序员在当时的想法而已。

4. 进一步回溯代码思路。该函数通过二级指针返回readindex所表示的数组地址，由于环形缓冲区本质上是一个线性数组，因此，当出现当bufsize - readindex >= size的情况时，将readindex指向的数组地址通过二级指针返回，且返回从readindex到数组终点处的size，至少，通过这两个信息来操作指针，降低了越界的风险。这一段是我对coder的想法猜测。

zw 打赏了 10.00 元 2022-05-28 09:00:53

lchnu 2022-05-26

Witness, Understand, Skill

当然，从代码分析的角度能得到上述结论。但是，本着务实的态度，随手写一段代码验证。

```c
#include <rtthread.h>

#define DBG_TAG "main"
#define DBG_LVL DBG_LOG
#include <rtdbg.h>

#include "ipc/ringbuffer.h"

int main(void)
{
    struct rt_ringbuffer *rb;
    rt_uint8_t *ptr;
    rt_uint8_t array[3] = {1, 2, 3};

rb = rt_ringbuffer_create(8);
    LOG_I("Init Rb");
    LOG_I("rb size is %x, write is %x, read is %x", rb->buffer_size, rb->write_index, rb->read_index);

LOG_I("Write Rb");
    rt_ringbuffer_put(rb, array, 3);
    LOG_I("rb size is %x, write is %x, read is %x", rb->buffer_size, rb->write_index, rb->read_index);

LOG_I("Peak Rb");
    rt_size_t size = rt_ringbuffer_peak(rb, &ptr);
    LOG_I("rb size is %x, write is %x, read is %x, peak size is %d", rb->buffer_size, rb->write_index, rb->read_index, size);

LOG_I("available size is %d", rt_ringbuffer_data_len(rb));

LOG_I("Write Rb agian");
    rt_ringbuffer_put(rb, array, 3);
    LOG_I("size is %x, write is %x, read is %x", rb->buffer_size, rb->write_index, rb->read_index);

LOG_I("available size is %d", rt_ringbuffer_data_len(rb));

return RT_EOK;
}

```

![image.png](https://oss-club.rt-thread.org/uploads/20220526/0e46653becb12c275d096ddea4f4c4d1.png)