嵌入式软件工程师在日常开发过程中的关键组件

Linux阅码场 2021-09-24 1223

描述

大家好，周末快乐，我是小麦，今天分享一下CBUF。

循环缓冲区是嵌入式软件工程师在日常开发过程中的关键组件。

多年来，互联网上出现了许多不同的循环缓冲区实现和示例。我非常喜欢这个模块，可以GitHub上找到这个开源的 CBUF.h 模块。

地址：https://github.com/barraq/BRBrain/blob/master/firmware/CBUF.h

CBUF.h 模块使用宏实现循环缓冲区，具体源码如下所示；

#if ！defined（ CBUF_H ）#define CBUF_H /**《 Include Guard *//* ---- Include Files ---------------------------------------------------- *//* ---- Constants and Types ---------------------------------------------- *//**

* Initializes the circular buffer for use.

#define CBUF_Init（ cbuf ） cbuf.m_getIdx = cbuf.m_putIdx = 0/**

* Returns the number of elements which are currently contained in the

* circular buffer.

*/#define CBUF_Len（ cbuf ）（（typeof（ cbuf.m_putIdx ））（（ cbuf.m_putIdx ） - （ cbuf.m_getIdx ）））/**

* Appends an element to the end of the circular buffer

*/#define CBUF_Push（ cbuf， elem ）（cbuf.m_entry）［ cbuf.m_putIdx++ & （（ cbuf##_SIZE ） - 1 ）］ = （elem）/**

* Retrieves an element from the beginning of the circular buffer

*/#define CBUF_Pop（ cbuf ）（cbuf.m_entry）［ cbuf.m_getIdx++ & （（ cbuf##_SIZE ） - 1 ）］/**

* Retrieves the i‘th element from the beginning of the circular buffer

*/#define CBUF_Get（ cbuf， idx ）（cbuf.m_entry）［（ cbuf.m_getIdx + idx ） & （（ cbuf##_SIZE ） - 1 ）］/**

* Retrieves the i’th element from the end of the circular buffer

*/#define CBUF_GetEnd（ cbuf， idx ）（cbuf.m_entry）［（ cbuf.m_putIdx - idx - 1 ） & （（ cbuf##_SIZE ） - 1 ）］/**

* Determines if the circular buffer is empty

*/#define CBUF_IsEmpty（ cbuf ）（ CBUF_Len（ cbuf ） == 0 ）/**

* Determines if the circular buffer is full.

*/#define CBUF_IsFull（ cbuf ）（ CBUF_Len（ cbuf ） == （ cbuf##_SIZE ））/**

* Determines if the circular buffer is currenly overflowed or underflowed.

*/#define CBUF_Error（ cbuf ）（ CBUF_Len（ cbuf ）》 cbuf##_SIZE ）#if defined（ __cplusplus ）template 《 class IndexType， unsigned Size， class EntryType 》

class CBUF

{public：

CBUF（）

{

m_getIdx = m_putIdx = 0;

}

IndexType Len（） const { return m_putIdx - m_getIdx; }

bool IsEmpty（） const { return Len（） == 0; }

bool IsFull（） const { return Len（） == Size; }

bool Error（） const { return Len（）》 Size; }

void Push（ EntryType val ）

{

m_entry［ m_putIdx++ & （ Size - 1 ）］ = val;

}

EntryType Pop（）

{

return m_entry［ m_getIdx++ & （ Size - 1 ）］;

}

private：

volatile IndexType m_getIdx;

volatile IndexType m_putIdx;

EntryType m_entry［ Size ］;

};

#endif // __cplusplus/* ---- Variable Externs ------------------------------------------------- *//* ---- Function Prototypes ---------------------------------------------- *//** @} */#endif // CBUF_H

现在一般我不喜欢以这种方式使用宏，但实现已被证明是快速、高效且工作相对良好的，这是很难争论的。

循环缓冲区的设置非常简单。首先，需要定义循环缓冲区的大小。这是通过定义宏 myQ_SIZE 来完成的，同时记住缓冲区大小需要是 2 的幂。

然后通过创建一个 myQ 类型的变量来声明循环缓冲区。例如，如果 myQ_SIZE 定义为 64 字节，则可以定义 UART 的发送和接收缓冲区，如下面的图 1 所示。