【C语言】环形缓冲区

---

一、环形缓冲区的特性

1、先进新出
2、当缓冲区被使用完，且又有新的数据需要存储时，丢掉历史最久的数据，保存最新数据。
现实中的存储介质都是线性的，因此我们需要做一下处理，才能在功能上实现环形缓冲区。
这里写图片描述：

二、算法说明

1、pHead和pTail分别是连续存储介质的首地址和尾地址
2、pTail - pHead 的值是环形缓冲区的总长度
3、pValid 是使用区域的起始指针，取数据时的起点，当取数据时pValid要发生偏移
4、pValidTail 是使用区域的的结尾指针，存数据时的起点，当存数据时，pValidTail要发生偏移
5、现有长度为addLen字节要存入,当pValidTail + addLen > pTail 时（超出了缓冲区，这时就要绕到开头pHead）
int len1 = pTail - pValidTail;
int len2 = addLen - len1;
pValidTail = pHead + len2;//新的使用区的尾指针
6、判断总长度是否变更，即是否有数据覆盖pValid所指向的区域，如果有，要偏移pValid

三、代码示例

ringbuffer.c

#include "ringbuffer.h"
#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#define BUFFER_SIZE 16 //缓冲区的长度,可以修改

static u32 validLen;          //已使用的数据长度
static u8 *pHead = NULL;      //环形存储区的首地址
static u8 *pTail = NULL;      //环形存储区的结尾地址
static u8 *pValid = NULL;     //已使用的缓冲区的首地址
static u8 *pValidTail = NULL; //已使用的缓冲区的尾地址

/*
 * 初始化环形缓冲区
 * 环形缓冲区这里可以是malloc申请的内存,也可以是Flash存储介质
 * */
void initRingbuffer(void) {
    if (pHead == NULL) {
        pHead = (u8 *)malloc(BUFFER_SIZE);
    }
    pValid = pValidTail = pHead;
    pTail = pHead + BUFFER_SIZE;
    validLen = 0;
}

/*
 * function:向缓冲区中写入数据
 * param:@buffer 写入的数据指针
 * 		 @addLen 写入的数据长度
 * return:-1:写入长度过大
 * 		  -2:缓冲区没有初始化
 * */
int wirteRingbuffer(u8 *buffer, u32 addLen) {
    if (addLen > BUFFER_SIZE)
        return -2;
    if (pHead == NULL)
        return -1;
    assert(buffer);

    //将要存入的数据copy到pValidTail处
    if (pValidTail + addLen > pTail) //需要分成两段copy
    {
        int len1 = pTail - pValidTail;
        int len2 = addLen - len1;
        memcpy(pValidTail, buffer, len1);
        memcpy(pHead, buffer + len1, len2);
        pValidTail = pHead + len2; //新的有效数据区结尾指针
    } else {
        memcpy(pValidTail, buffer, addLen);
        pValidTail += addLen; //新的有效数据区结尾指针
    }

    //需重新计算已使用区的起始位置
    if (validLen + addLen > BUFFER_SIZE) {
        int moveLen = validLen + addLen - BUFFER_SIZE; //有效指针将要移动的长度
        if (pValid + moveLen > pTail) //需要分成两段计算
        {
            int len1 = pTail - pValid;
            int len2 = moveLen - len1;
            pValid = pHead + len2;
        } else {
            pValid = pValid + moveLen;
        }
        validLen = BUFFER_SIZE;
    } else {
        validLen += addLen;
    }

    return 0;
}

/*
 * function:从缓冲区内取出数据
 * param   :@buffer:接受读取数据的buffer
 *		    @len:将要读取的数据的长度
 * return  :-1:没有初始化
 *	 	    >0:实际读取的长度
 * */
int readRingbuffer(u8 *buffer, u32 len) {
    if (pHead == NULL)
        return -1;

    assert(buffer);

    if (validLen == 0)
        return 0;

    if (len > validLen)
        len = validLen;

    if (pValid + len > pTail) //需要分成两段copy
    {
        int len1 = pTail - pValid;
        int len2 = len - len1;
        memcpy(buffer, pValid, len1); //第一段
        memcpy(buffer + len1, pHead, len2); //第二段，绕到整个存储区的开头
        pValid = pHead + len2;              //更新已使用缓冲区的起始
    } else {
        memcpy(buffer, pValid, len);
        pValid = pValid + len; //更新已使用缓冲区的起始
    }
    validLen -= len; //更新已使用缓冲区的长度

    return len;
}

/*
 * function:获取已使用缓冲区的长度
 * return  :已使用的buffer长度
 * */
u32 getRingbufferValidLen(void) { return validLen; }

/*
 * function:释放环形缓冲区
 * */
void releaseRingbuffer(void) {
    if (pHead != NULL)
        free(pHead);
    pHead = NULL;
}

ringbuffer.h

#ifndef RINGBUFFER_H_
#define RINGBUFFER_H_
typedef unsigned char u8;
typedef unsigned int u32;


#ifdef __cplusplus             //告诉编译器，这部分代码按C语言的格式进行编译，而不是C++的
extern "C"{
#endif
 
void initRingbuffer(void);
int wirteRingbuffer(u8 *buffer, u32 len);
int readRingbuffer(u8 *buffer, u32 len);
u32 getRingbufferValidLen(void);
void releaseRingbuffer(void);
 
#ifdef __cplusplus
}
 
#endif

#endif /* RINGBUFFER_H_ */

main.c

#include "ringbuffer.h"
#include <stdio.h>
#include <stdlib.h>
// 主函数
int main(int argc, char const *argv[]) {
    char c;
    int readLen;
    u8 readBuffer[10];
    // setvbuf(stdout,NULL,_IONBF,0); //pinrtf、putchar不能立马输出，打开此注释
    initRingbuffer();

    printf("Please enter a line [blank line to terminate]> ");
    do {
        c = getchar();
        putchar(c);
        switch (c) {
        case 'Q':
            goto exit;
            break;
        case 'R':
            readLen = readRingbuffer(readBuffer, 10);
            printf("readRingbuffer len:%d\n", readLen);
            if (readLen > 0) {
                printf("readRingbuffer:");
                for (int i = 0; i < readLen; i++) {
                    printf("%c ", (char)readBuffer[i]);
                }
                printf("\n");
            }
            break;
        default:
            if (c != '\n')
                wirteRingbuffer((u8 *)&c, 1);
            break;
        }
    } while (1);

exit:
    releaseRingbuffer();
    printf("exit.\n");
    return 0;
}