單片機中的幾種環形緩沖區的分析和實現

一、簡介

環形緩沖區（Ring Buffer）是一種高效的使用內存的方法，它將一段固定長度的內存看成一個環形結構，用于存儲數據，能夠避免使用動態申請內存導致的內存碎片問題，而且其能夠更高效的使用內存。

在單片機中，由于內存有限，而且需要盡可能避免使用動態內存，所以環形緩沖區在單片機中應用非常廣泛。

二、原理

通常我們需要使用一個數組或者在程序開頭申請一段不被釋放的內存，將其作為緩沖區。然后使用兩個指令分別指向讀寫位置。

使用讀指針管理讀位置，使用寫指針管理寫位置。當讀指針追上寫指針時，表示緩沖區為空，當寫指針追上讀指針時，表示緩沖區已滿。

環形緩沖區的讀寫操作都是循環進行的，當讀指針或寫指針到達緩沖區的末尾時，會自動回到緩沖區的開頭。

環形緩沖區的讀寫操作都是原子操作，即一次只能進行一個讀寫操作，避免了多線程或多任務同時讀寫緩沖區導致的數據混亂。

三、實現

緩沖區滿了以后可以選擇覆蓋寫或者阻塞等待，需要注意的是，如果選擇覆蓋寫，那么讀索引也應該向前移動，此時最前面的數據就會丟失；如果選擇阻塞等待的話，盡可能不要在中斷中使用，否則中斷嵌套會有無法預料的執行流程。

注：我們可以使用數組索引代替讀寫指針位置，畢竟對整數的加減還是比較容易理解的。下面我將讀指針用讀索引代替，寫指針用寫索引代替。

1、數據結構設計

我們需要支持多個環形緩沖區，使用同一套代碼邏輯，那么就不能將緩沖區數組的大小進行硬編碼，而是需要在初始化環形緩沖區的時候通過參數傳遞進來，我們使用一個結構體來表示緩沖區數組。

我們的緩沖區不能只是支持字節數組，而是支持任意類型的數據，所以我們需要一個變量來保存緩沖區數組中每個元素的大小，這樣我們就可以根據這個大小然后結合讀寫索引來獲取和寫入數據。

typedef struct{ void *ptr; // 緩沖區數組指針 uint32_t elem_num; // 緩沖區數組元素個數 uint32_t elem_size; // 緩沖區數組中每個元素的大小} Array;

我們通過一個環形緩沖區的結構體來管理緩沖區，讀寫索引，同時使用一個變量來記錄當前緩沖區中有效的元素個數，以便判斷環形緩沖區是否為空或者是否已滿。

如果在RTOS中使用環形緩沖區，那么讀寫索引需要使用原子操作，防止多線程或多任務同時讀寫緩沖區導致的數據混亂。為保證可以實現原子操作，需要傳入RTOS提供的原子操作方法(進入臨界區、互斥量等)

typedef struct{ Array *buffer; // 緩沖區 uint32_t read_index; // 讀索引 uint32_t write_index; // 寫索引 uint32_t count; // 環形緩沖區中元素個數 void (*lock)(void); // 進入原子操作 void (*unlock)(void); // 退出原子操作} RingBuffer;

為了及時了解我們的函數執行結果，我們在函數執行結束后需要返回一個錯誤碼用于判斷執行情況。

typedef enum{ ARRAY_OK, // 成功 ARRAY_PARAMS_NULL, // 參數為空 ARRAY_INDEX_OUT_OF_RANGE, // 索引越界} ArrayError;typedef enum{ RB_OK, // 操作成功 RB_READ_NOT_ENOUGH, // 緩沖區中元素個數不足，這只是一個警告，程序可以進行進行 RB_PARAM_ERROR, // 參數錯誤 RB_FULL, // 緩沖區已滿 RB_EMPTY, // 緩沖區為空} RingBufferStatus;

2、方法實現

我們的緩沖區其實就是一個數組，但是我們這里為了支持存儲不同類型的元素，使用了Array來對這個數組進行管理（類似C++中的Vector）。

在讀寫某個元素的時候，需要判斷輸入的索引是否在范圍內。

// 初始化數組// pthis: 數組結構體指針// ptr: 數組指針// size: 數組元素個數// elem_size: 數組中每個元素的大小ArrayError array_init(Array *pthis, void *ptr, const uint32_t elem_num, const uint32_t elem_size){ if (pthis == NULL || ptr == NULL) { return ARRAY_PARAMS_NULL; } pthis->ptr = ptr; pthis->elem_num = elem_num; pthis->elem_size = elem_size; return ARRAY_OK;}// 獲取數組元素個數// pthis: 數組結構體指針uint32_t array_get_elem_num(Array *pthis){ return pthis->elem_num;}// 獲取數組中每個元素的大小// pthis: 數組結構體指針uint32_t array_get_elem_size(Array *pthis){ return pthis->elem_size;}// 向數組寫入一個元素// pthis: 數組結構體指針// index: 要寫入的元素索引// elem: 要寫入的元素ArrayError array_write_elem(Array *pthis, const uint32_t index, const void *elem){ if (pthis == NULL || elem == NULL) { return ARRAY_PARAMS_NULL; } if (index >= pthis->elem_num) { return ARRAY_INDEX_OUT_OF_RANGE; } memcpy((char *)pthis->ptr + index * pthis->elem_size, elem, pthis->elem_size); return ARRAY_OK;}// 從數組讀取一個元素// pthis: 數組結構體指針// index: 要讀取的元素索引// elem: 讀取的元素ArrayError array_read_elem(Array *pthis, const uint32_t index, void *elem){ if (pthis == NULL || elem == NULL) { return ARRAY_PARAMS_NULL; } if (index >= pthis->elem_num) { return ARRAY_INDEX_OUT_OF_RANGE; } memcpy(elem, (char *)pthis->ptr + index * pthis->elem_size, pthis->elem_size); return ARRAY_OK;}

為了方便判斷環形緩沖區是否滿或者空了，我使用一個變量來記錄有效的元素數量，當有效元素數量為0時表示環形緩沖區空了，當有效元素數量為緩存數組的長度時表示環形緩沖區滿了。

讀寫多個元素時，在內部都是一個一個進行的讀寫，只有在讀寫某個元素前才后判斷環形緩沖區是否滿或者空。那么讀寫多個元素的操作就不一定都能成功，在這里如果全部讀寫成功
或者只是因為環形緩沖區滿、空導致失敗，只需要返回成功讀寫的數據，如果是其他原因導致的讀寫失敗，那么就需要根據RingBufferStatus的枚舉類型返回相應的負數。

#define RB_LOCK() \ if (rb->lock) \ rb->lock()#define RB_UNLOCK() \ if (rb->unlock) \ rb->unlock()// 初始化環形緩沖區// @rb: 環形緩沖區// @array: 環形緩沖區使用的數組// @lock: 鎖函數，進入原子操作時調用// @unlock: 解鎖函數，退出原子操作時調用// 返回值: RB_OK, RB_PARAM_ERRORRingBufferStatus ring_buffer_init(RingBuffer *rb, Array *array, void (*lock)(void), void (*unlock)(void)){ if (rb == NULL || array == NULL) { return RB_PARAM_ERROR; } rb->buffer = array; rb->lock = lock; rb->unlock = unlock; rb->write_index = 0; rb->read_index = 0; rb->count = 0; return RB_OK;}// 向環形緩沖區寫入一個元素// @rb: 環形緩沖區// @data: 要寫入的數據// 返回值: RB_OK, RB_FULL, RB_PARAM_ERRORstatic RingBufferStatus ring_buffer_write_one(RingBuffer *rb, const void *data){ ArrayError err = ARRAY_OK; if (rb == NULL || data == NULL) { return RB_PARAM_ERROR; } if (rb->count == array_get_elem_num(rb->buffer)) { return RB_FULL; } err = array_write_elem(rb->buffer, rb->write_index, data); if (err != ARRAY_OK) { return RB_PARAM_ERROR; } rb->write_index = (rb->write_index + 1) % array_get_elem_num(rb->buffer); rb->count++; return RB_OK;}// 從環形緩沖區讀取一個元素// @rb: 環形緩沖區// @data: 讀取的數據// 返回值: RB_OK, RB_EMPTY, RB_PARAM_ERRORstatic RingBufferStatus ring_buffer_read_one(RingBuffer *rb, void *data){ ArrayError err = ARRAY_OK; if (rb == NULL || data == NULL) { return RB_PARAM_ERROR; } if (rb->count == 0) { return RB_EMPTY; } err = array_read_elem(rb->buffer, rb->read_index, data); if (err != ARRAY_OK) { return RB_PARAM_ERROR; } rb->read_index = (rb->read_index + 1) % array_get_elem_num(rb->buffer); rb->count--; return RB_OK;}// 向環形緩沖區寫入數據// @rb: 環形緩沖區// @data: 要寫入的數據// @elem_num: 要寫入的元素個數// 返回值: 當至少能寫入一個元素時，返回實際寫入的元素個數；其他時候返回 -RB_PARAM_ERROR, -RB_FULLint32_t ring_buffer_write(RingBuffer *rb, const void *data, const uint32_t elem_num){ RingBufferStatus ret = RB_OK; int32_t write_num = 0; if (rb == NULL || data == NULL || elem_num == 0) { return -RB_PARAM_ERROR; } RB_LOCK(); for (int32_t i = 0; i < elem_num; i++) { ret = ring_buffer_write_one(rb, (char *)data + i * array_get_elem_size(rb->buffer)); write_num++; if (ret != RB_OK) { break; } } RB_UNLOCK(); if (ret == RB_OK || ret == RB_FULL) { return write_num; // 返回實際寫入的元素個數 } else { return -ret; // 返回負數表示寫入失敗 }}// 從環形緩沖區讀取數據// @rb: 環形緩沖區// @data: 讀取的數據// @elem_num: 要讀取的元素個數// 返回值: 當至少能讀取一個元素時，返回實際讀取的元素個數；其他時候返回 -RB_PARAM_ERROR, -RB_EMPTYint32_t ring_buffer_read(RingBuffer *rb, void *data, const uint32_t elem_num){ RingBufferStatus ret = RB_OK; int32_t read_num = 0; if (rb == NULL || data == NULL || elem_num == 0) { return -RB_PARAM_ERROR; } RB_LOCK(); for (int32_t i = 0; i < elem_num; i++) { ret = ring_buffer_read_one(rb, (char *)data + i * array_get_elem_size(rb->buffer)); read_num++; if (ret != RB_OK) { break; } } RB_UNLOCK(); if (ret == RB_OK || ret == RB_READ_NOT_ENOUGH) { return read_num; // 返回實際讀取的元素個數 } else { return -ret; // 返回負數表示讀取失敗 }}

總結

本章主要介紹了一種在單片機中常用的環形緩沖區，分析了設計思路和代碼實現。