Ring Buffer的常规用法与高级用法(一)

Ring Buffer的常规用法与高级用法（一）

在涉及到模块与模块间数据传输缓存处理、通信程序中，经常使用环形缓冲区（Ring Buffer）作为数据结构来存放通信中发送和接收的数据，下面我将从以下几个方面介绍的是环形缓冲区（Ring Buffer）的常规用法与高级用法。

目录

---

环形缓冲区（Ring Buffer）的实现原理

环形缓冲区通常有一个读指针和一个写指针（一个入指针和一个出指针）。读指针指向环形缓冲区中可读的数据，写指针指向环形缓冲区中可写的缓冲区。通过移动读指针和写指针就可以实现缓冲区的数据读取和写入。在通常情况下，环形缓冲区的读用户仅仅会影响读指针，而写用户仅仅会影响写指针。如果仅仅有一个读用户和一个写用户，那么不需要添加互斥保护机制就可以保证数据的正确性。如果有多个读写用户访问环形缓冲区，那么必须添加互斥保护机制来确保多个用户互斥访问环形缓冲区

环形缓冲区（Ring Buffer）实现原理图解

1、环形缓冲区（Ring Buffer）初始态

2、向环形缓冲区（Ring Buffer）中添加一个数据

3、向环形缓冲区（Ring Buffer）中添加一个数据，并读取一个数据

注意：环形缓冲区是使用的线性存储区实现的，实际的物理存储是线性的
类似于二维或多维数组，其实际存储也是由线下存储实现

Ring Buffer的用法（C语言）

话不多说直接上代码，边分析代码、边理解原理

Ring Buffer的常规用法

Ring Buffer的数据结构定义：

struct ring_buffer {
    int in; /*写指针*/
    int out; /*读指针*/
    int size;  /*环形缓冲区大小*/
    char *buf; /*环形缓冲区*/
};

初始化Ring Buffer的接口：

bool RingBufferInit(struct ring_buffer *ring_buffer_p, int buf_size)
{
    ring_buffer_p->buf = (char *)malloc(buf_size);
    if (ring_buffer_p->buf) {
        memset(fifo_p->buf, 0, buf_size);
    } else {
        return false;
    }

    ring_buffer_p->size = buf_size;
    ring_buffer_p->head = 0;
    ring_buffer_p->tail = 0;
    return true;
}

判断Ring Buffer是否为空的接口：

bool RingBufferEmpty(struct ring_buffer *ring_buffer_p)
{
    return (ring_buffer_p->in == ring_buffer_p->out);
}

判断Ring Buffer是否为满的接口：

bool RingBufferFull(struct ring_buffer *ring_buffer_p)
{
    return (((ring_buffer_p->in) % ring_buffer_p->size) == ring_buffer_p->out);
}

读取Ring Buffer数据长度的接口：

int GetRingBufferLen(struct ring_buffer *ring_buffer_p)
{
    return (((ring_buffer_p>in - ring_buffer_p->out + ring_buffer_p->size) % ring_buffer_p->size);
}

清空Ring Buffer的接口：

void RingBufferClear(struct ring_buffer *ring_buffer_p)
{
    ring_buffer_p->in = 0;
    ring_buffer_p->out = 0;
}

释放Ring Buffer的接口：

void RingBufferClear(struct ring_buffer *ring_buffer_p)
{
    ring_buffer_p->in = 0;
    ring_buffer_p->out = 0;
    ring_buffer_p->size = 0;

    if(ring_buffer_p->buf) {
        free(ring_buffer_p->buf);
        ring_buffer_p->buf = NULL;
    }
}

向Ring Buffer的写数据接口：

int RingBufferPut(struct ring_buffer *ring_buffer_p, char *buf, int len)
{
    int real_int_len = 0 , i = 0, surplus_buf_len = 0;

    if( len >= ring_buffer_p->size){
        return -1;
    }

    surplus_buf_len = ring_buffer_p->size - GetRingBufferLen(ring_buffer_p);
    if( len > surplus_buf_len )
        real_in_len = surplus_buf_len;
    } else if( len <= surplus_buf_len){
        real_in_len = len;
    }

    for( i = 0; i < real_in_len; i++){
        ring_buffer_p->buf[ ring_buffer_p->in % ring_buffer_p->size] = buf[i];
        ring_buffer_p->in = (ring_buffer_p->in + 1) % ring_buffer_p->size;
    }

    return i;
}

读取Ring Buffer数据的接口：

int RingBufferGet(struct ring_buffer *ring_buffer_p, char *buf, int buf_len)
{
    hd_s32_t real_out_len = 0, i =0, data_len = 0;

    data_len = GetRingBufferLen(ring_buffer_p);
    if( buf_len > data_len )
        real_out_len = data_len;
    } else if( buf_len <= data_len){
        real_out_len = buf_len;
    }

    for( i = 0; i < real_out_len; i++){
        buf[i] = ring_buffer_p->buf[ring_buffer_p->out % ring_buffer_p->size];
        ring_buffer_p->out = (ring_buffer_p->out + 1) % ring_buffer_p->size;
    }
    return i;
}

---