专栏首页LINUX阅码场优雅地用宏实现环形缓冲区

优雅地用宏实现环形缓冲区

大家好,周末快乐,我是小麦,今天分享一下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 所示。

图 1 – 定义循环缓冲区

在此示例中,myQ 被定义为静态以限制缓冲区的范围并声明为易失性,因为它们在中断内被修改。定义循环缓冲区只是第一步。为了分配缓冲区,必须将这些变量传递给 CBUF_INIT 宏,如下图 2 所示。

图 2 – 缓冲区初始化

除了这个初始设置之外,缓冲区相当简单且易于使用。例如,可以使用 CBUF_PUSH 将通过串行接口接收 UART接收的字符推送到循环缓冲区,如图 3 所示。

图 3 – 推入缓冲区

开发人员不仅希望将数据推送到循环缓冲区上,还希望从缓冲区弹出或获取数据。看到这一点的一个简单示例是需要获取字符并通过 UART 传输的串行发送器。图 4 中可以看到一个示例传输函数。

图 4 – 从缓冲区弹出数据

在健壮的应用程序中,还应检查循环缓冲区长度和溢出状态。CBUF 模块确实提供了能够检查这些重要指标的宏。

要记住的一个重要问题是,如果需要对 CBUF 本身进行任何调试,这是不可能的。无法为宏设置断点,因此如果出现问题,则需要对模块进行功能化以逐步执行和调试。

多年来使用这个模块虽然我没有发现任何问题。循环缓冲区是在嵌入式系统中与串行设备通信的一个重要方面。

循环缓冲区也很好理解,应该创建它们以便它们可以模块化并从一个应用程序到下一个应用程序重复使用。

到目前为止,CBUF 模块已被证明是这样一个模块,所以在这里,我强烈推荐一下这个模块。好了,今天的文章就到这里,我们下期再见。

本文分享自微信公众号 - Linux阅码场(LinuxDev)

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2021-09-09

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 环形缓冲区的实现

    队列 (Queue):是一种先进先出(First In First Out ,简称 FIFO)的线性表,只允许在一端插入(入队),在另一端进行删除(出队)。

    刘盼
  • 第10期 | ringbuff,通用FIFO环形缓冲区实现库

    本专栏由Mculover666创建,主要内容为寻找嵌入式领域内的优质开源项目,一是帮助开发者使用开源项目实现更多的功能,二是通过这些开源项目,学习大佬的代码及背...

    Mculover666
  • 第10期 | ringbuff,通用FIFO环形缓冲区实现库

    本期给大家带来的开源项目是 ringbuff ,一款通用FIFO环形缓冲区实现的开源库,作者MaJerle,目前收获 79 个 star,遵循 MIT 开源许可...

    morixinguan
  • 【RL-TCPnet网络教程】第6章 RL-TCPnet底层驱动说明

    本章节为大家讲解RL-TCPnet的底层驱动,主要是STM32自带MAC的驱动实现和PHY的驱动实现。

    armfly
  • zephyr笔记 2.5.4 消息队列

    消息队列是实现简单消息队列的内核对象,允许线程和ISR异步发送和接收固定大小的数据项。

    twowinter
  • 数据结构 | TencentOS-tiny中队列、环形队列、优先级队列的实现及使用

    队列(queue)是一种只能在一端插入元素、在另一端删除元素的数据结构,遵循「先入先出」(FIFO)的规则。

    Mculover666
  • OTL技术应用

    什么是OTL:OTL 是 Oracle, Odbc and DB2-CLI TemplateLibrary 的缩写,是一个操控关系数据库的C++模板库,它目前几...

    cloudskyme
  • EasyFlash 移植说明

    [点击此链接](https://github.com/armink/EasyFlash/archive/master.zip)即可直接下载位于Github上的源...

    心跳包
  • 【RL-TCPnet网络教程】第21章 RL-TCPnet之高效的事件触发框架

    本章节为大家讲解高效的事件触发框架实现方法,BSD Socket编程和后面章节要讲解到的FTP、TFTP和HTTP等都非常适合使用这种方式。实际项目中也推荐大家...

    armfly
  • 浏览器原理学习笔记04—浏览器中的页面事件循环系统

    每个渲染进程都有一个非常繁忙的主线程,需要一个系统来统筹调度任务(具体任务后面详解)

    CS逍遥剑仙
  • MapReduce快速入门系列(11) | MapTask,ReduceTask以及MapReduce运行机制详解

      整个Map阶段流程大体如上图所示。简单概述:inputFile通过split被逻辑切分为多个split文件,通过Record按行读取内容给map(用户自己实...

    不温卜火
  • MapTask,ReduceTask,MapReduce运行机制详解

    在之前的博客中,小菌为大家分享了MapReduce的整体流程。这篇博客,主要针对MapTask与ReduceTask运行机制的一个详解与MapR...

    大数据梦想家
  • 为什么Redis需要两种持久化?

    根据这些对比,可以看到RDB持久化更适合保存一个时间点的数据,在主从复制或者数据全量异地灾备时,拷贝到其他地方,而AOF持久化由于丢失数据较少,比较适合作为本地...

    玖柒的小窝
  • 在线音频的新战局

    在线音频,一直都是泛娱乐行业的边缘地带。不过,这片互联网的“远郊”,却正在酝酿着足以撼动数字世界整体固有格局的力量。

    刘旷
  • 【问底】徐汉彬:大规模网站架构的缓存机制和几何分形学

    【导读】徐汉彬曾在阿里巴巴和腾讯从事4年多的技术研发工作,负责过日请求量过亿的Web系统升级与重构,目前在小满科技创业,从事SaaS服务技术建设。 在过去的工...

    CSDN技术头条
  • C/C++语言 常用头文件及函数

    #include <assert.h>    //设定插入点 #include <ctype.h>     //字符处理 #include <errno.h> ...

    用户7886150
  • C/C++常用头文件及函数汇总

    C/C++头文件一览 C #include <assert.h>    //设定插入点 #include <ctype.h>     //字符处理 #inclu...

    互联网金融打杂
  • 11.反恶意软件扫描接口 (AMSI)

    Windows 反恶意软件扫描接口 (AMSI) 是一种通用接口标准,可以集成在应用程序和服务与机器上存在的任何反恶意软件产品中。可以增强杀毒软件的查杀能力。

    黑白天安全
  • 【RL-TCPnet网络教程】第20章 RL-TCPnet之BSD Socket客户端

    本章节为大家讲解RL-TCPnet的BSD Socket,学习本章节前,务必要优先学习第18章的Socket基础知识。有了这些基础知识之后,再搞本章节会有事半功...

    armfly

扫码关注云+社区

领取腾讯云代金券