循環buffer的實現

原文鏈接：https://blog.csdn.net/maowentao0416/article/details/81984269

1.循環buffer的特點

1、先進先出
2、當空閒緩衝區用完，且又有新的數據需要存儲時，覆蓋歷史數據，保存新的數據

3、環形緩衝區在實現時採用的是線型的存儲結構

4、線型存儲中需要四個指針，分別爲緩衝區首地址指針（pHead）、尾地址指針（pTail）、有效數據起始指針（pValid）、有效數據尾指針（pValidTail）。其中pValid<pValidTail或者pValid>=pValidTtail，如下圖所示：

2.循環buffer的實現

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include "ringBuffer.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;
}