ring_buffer.h
#ifndef _RING_BUFFER_H_
#define _RING_BUFFER_H_
#ifdef __cplusplus
extern "C"
{
#endif
#include <pthread.h>
#include <stdint.h>
#include <stddef.h>
typedef struct ring_buffer ring_buffer;
// 初始化环形缓冲区
ring_buffer *ring_buffer_create(size_t capacity, size_t block_size);
// 销毁环形缓冲区
void ring_buffer_destroy(ring_buffer **pp_rb);
// 向环形缓冲区中写入数据,返回 0 成功,负数失败,
// 如果缓冲区满了,timeout_ms > 0: 最多阻塞timeout_ms毫秒;timeout_ms == 0: 立即返回;timeout_ms < 0: 永久阻塞直到有空间
int ring_buffer_write(ring_buffer *rb, const void *data, size_t size, int timeout_ms);
// 从环形缓冲区中读取数据,返回 0 成功,负数失败,
// 如果缓冲区没有数据, timeout_ms > 0: 最多阻塞timeout_ms毫秒;timeout_ms == 0: 立即返回;timeout_ms < 0: 永久阻塞直到有数据
int ring_buffer_read(ring_buffer *rb, void *data, size_t *size, int timeout_ms);
// 读取但不删除数据,返回 0 成功,负数失败,
// 如果缓冲区没有数据,timeout_ms > 0: 最多阻塞timeout_ms毫秒;timeout_ms == 0: 立即返回;timeout_ms < 0: 永久阻塞直到有数据
int ring_buffer_peek(ring_buffer *rb, void *data, size_t *size, int timeout_ms);
// 删除队首数据
int ring_buffer_remove(ring_buffer *rb);
// 获取当前缓冲区长度,成功返回缓冲区长度,失败返回-1
int ring_buffer_length(ring_buffer *rb);
// 判断缓冲区是否已满,-1 失败,0 未满,1 满
int ring_buffer_is_full(ring_buffer *rb);
// 判断缓冲区是否为空,-1 失败,0 不为空,1 为空
int ring_buffer_is_empty(ring_buffer *rb);
// 清空缓冲区
void ring_buffer_clear(ring_buffer *rb);
#ifdef __cplusplus
}
#endif
#endif // _RING_BUFFER_H_
ring_buffer.c
#ifndef _POSIX_C_SOURCE
#define _POSIX_C_SOURCE 200809L
#endif
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <errno.h>
#include <stdint.h>
#include "ring_buffer.h"
// 数据块结构体
struct ring_buffer_item
{
void *data; // 数据指针
size_t size; // 数据大小
};
// 环形缓冲区结构体
struct ring_buffer
{
struct ring_buffer_item *buffer; // 数据缓冲区
size_t capacity; // 缓冲区容量(以数据块为单位)
uint32_t count; // 当前缓冲区中数据块的数量
size_t block_size; // 每个数据块的固定大小(以字节为单位)
size_t head; // 缓冲区头部索引
size_t tail; // 缓冲区尾部索引
pthread_mutex_t lock;
pthread_cond_t cond_not_full;
pthread_cond_t cond_not_empty;
};
// 初始化环形缓冲区
ring_buffer *ring_buffer_create(size_t capacity, size_t block_size)
{
if (!capacity || !block_size)
return NULL;
ring_buffer *rb = malloc(sizeof(struct ring_buffer));
if (!rb)
return NULL;
rb->buffer = malloc(capacity * sizeof(struct ring_buffer_item));
if (!rb->buffer)
goto fail;
for (size_t i = 0; i < capacity; ++i)
{
rb->buffer[i].data = malloc(block_size);
if (!rb->buffer[i].data)
{
// 释放已分配的 data
for (size_t j = 0; j < i; ++j)
free(rb->buffer[j].data);
goto fail1;
}
rb->buffer[i].size = 0;
}
rb->capacity = capacity;
rb->count = 0;
rb->block_size = block_size;
rb->head = 0;
rb->tail = 0;
pthread_mutex_init(&rb->lock, NULL);
pthread_condattr_t attr;
pthread_condattr_init(&attr);
pthread_condattr_setclock(&attr, CLOCK_MONOTONIC);
pthread_cond_init(&rb->cond_not_full, &attr);
pthread_cond_init(&rb->cond_not_empty, &attr);
pthread_condattr_destroy(&attr);
return rb;
fail1:
free(rb->buffer);
fail:
free(rb);
return NULL;
}
// 销毁环形缓冲区
void ring_buffer_destroy(ring_buffer **pp_rb)
{
if (!pp_rb && !(*pp_rb))
return;
ring_buffer *rb = *pp_rb;
for (size_t i = 0; i < rb->capacity; ++i)
{
free(rb->buffer[i].data);
}
free(rb->buffer);
pthread_mutex_destroy(&rb->lock);
pthread_cond_destroy(&rb->cond_not_full);
pthread_cond_destroy(&rb->cond_not_empty);
free(rb);
*pp_rb = NULL;
}
// 超时时间转换为绝对时间
static int get_abs_timespec(struct timespec *abstime, uint32_t timeout_ms)
{
struct timespec now;
clock_gettime(CLOCK_MONOTONIC, &now);
abstime->tv_sec = now.tv_sec + timeout_ms / 1000;
abstime->tv_nsec = now.tv_nsec + (timeout_ms % 1000) * 1000000;
if (abstime->tv_nsec >= 1000000000)
{
abstime->tv_sec += 1;
abstime->tv_nsec -= 1000000000;
}
return 0;
}
// 写入数据
int ring_buffer_write(ring_buffer *rb, const void *data, size_t size, int timeout_ms)
{
if (!rb || !data || !size || size > rb->block_size)
return -1;
int ret = 0;
pthread_mutex_lock(&rb->lock);
// 处理缓冲区满的情况
while (rb->count == rb->capacity)
{
int wait_ret = 0;
if (timeout_ms == 0)
{
ret = -2; // 缓冲区满且不等待
break;
}
else if (timeout_ms > 0)
{
struct timespec abstime;
get_abs_timespec(&abstime, timeout_ms);
wait_ret = pthread_cond_timedwait(&rb->cond_not_full, &rb->lock, &abstime);
if (wait_ret == ETIMEDOUT)
{
ret = -2; // 超时
break;
}
else if (wait_ret != 0)
{
ret = -1;
break;
}
}
else
{ // timeout_ms < 0,永久等待
wait_ret = pthread_cond_wait(&rb->cond_not_full, &rb->lock);
if (wait_ret != 0)
{
ret = -1;
break;
}
}
}
if (ret == 0)
{
memcpy(rb->buffer[rb->tail].data, data, size);
rb->buffer[rb->tail].size = size;
rb->tail = (rb->tail + 1) % rb->capacity;
rb->count++;
pthread_cond_signal(&rb->cond_not_empty);
}
pthread_mutex_unlock(&rb->lock);
return ret;
}
// 读取数据
int ring_buffer_read(ring_buffer *rb, void *data, size_t *size, int timeout_ms)
{
if (!rb || !data || !size)
return -1;
int ret = 0;
pthread_mutex_lock(&rb->lock);
while (rb->count == 0)
{
int wait_ret = 0;
if (timeout_ms == 0)
{
ret = -2;
break;
}
else if (timeout_ms > 0)
{
struct timespec abstime;
get_abs_timespec(&abstime, timeout_ms);
wait_ret = pthread_cond_timedwait(&rb->cond_not_empty, &rb->lock, &abstime);
if (wait_ret == ETIMEDOUT)
{
ret = -2;
break;
}
if (wait_ret != 0)
{
ret = -1;
break;
}
}
else
{
wait_ret = pthread_cond_wait(&rb->cond_not_empty, &rb->lock);
if (wait_ret != 0)
{
ret = -1;
break;
}
}
}
if (ret == 0)
{
memcpy(data, rb->buffer[rb->head].data, rb->buffer[rb->head].size);
*size = rb->buffer[rb->head].size;
rb->buffer[rb->head].size = 0;
rb->head = (rb->head + 1) % rb->capacity;
rb->count--;
pthread_cond_signal(&rb->cond_not_full);
}
pthread_mutex_unlock(&rb->lock);
return ret;
}
// 获取队首数据
int ring_buffer_peek(ring_buffer *rb, void *data, size_t *size, int timeout_ms)
{
if (!rb || !data || !size)
return -1;
int ret = 0;
pthread_mutex_lock(&rb->lock);
while (rb->count == 0)
{
int wait_ret = 0;
if (timeout_ms == 0)
{
ret = -2;
break;
}
else if (timeout_ms > 0)
{
struct timespec abstime;
get_abs_timespec(&abstime, timeout_ms);
wait_ret = pthread_cond_timedwait(&rb->cond_not_empty, &rb->lock, &abstime);
if (wait_ret == ETIMEDOUT)
{
ret = -2;
break;
}
if (wait_ret != 0)
{
ret = -1;
break;
}
}
else
{
wait_ret = pthread_cond_wait(&rb->cond_not_empty, &rb->lock);
if (wait_ret != 0)
{
ret = -1;
break;
}
}
}
if (ret == 0)
{
memcpy(data, rb->buffer[rb->head].data, rb->buffer[rb->head].size);
*size = rb->buffer[rb->head].size;
ret = 0;
}
pthread_mutex_unlock(&rb->lock);
return ret;
}
// 删除队首数据
int ring_buffer_remove(ring_buffer *rb)
{
if (!rb)
return -1;
pthread_mutex_lock(&rb->lock);
if (rb->count > 0)
{
rb->buffer[rb->head].size = 0;
rb->head = (rb->head + 1) % rb->capacity;
rb->count--;
}
pthread_cond_signal(&rb->cond_not_full);
pthread_mutex_unlock(&rb->lock);
return 0;
}
// 获取当前缓冲区长度
int ring_buffer_length(ring_buffer *rb)
{
if (!rb)
return -1;
pthread_mutex_lock(&rb->lock);
int length = rb->count;
pthread_mutex_unlock(&rb->lock);
return length;
}
// 判断缓冲区是否已满
int ring_buffer_is_full(ring_buffer *rb)
{
if (!rb)
return -1;
pthread_mutex_lock(&rb->lock);
int is_full = (rb->count == rb->capacity) ? 1 : 0;
pthread_mutex_unlock(&rb->lock);
return is_full;
}
// 判断缓冲区是否为空
int ring_buffer_is_empty(ring_buffer *rb)
{
if (!rb)
return -1;
pthread_mutex_lock(&rb->lock);
int is_empty = (rb->count == 0) ? 1 : 0;
pthread_mutex_unlock(&rb->lock);
return is_empty;
}
// 清空缓冲区
void ring_buffer_clear(ring_buffer *rb)
{
if (!rb)
return;
pthread_mutex_lock(&rb->lock);
for (size_t i = 0; i < rb->capacity; ++i)
{
memset(rb->buffer[i].data, 0, rb->block_size);
rb->buffer[i].size = 0;
}
rb->count = 0;
rb->head = 0;
rb->tail = 0;
pthread_cond_signal(&rb->cond_not_full);
pthread_mutex_unlock(&rb->lock);
}
测试 main.c :
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <pthread.h>
#include <unistd.h>
#include <sys/time.h>
#include "ring_buffer.h"
#define TEST_CAPACITY 4
#define TEST_BLOCK_SIZE 16
// 全局统计变量
static int total_tests = 0;
static int passed_tests = 0;
static int failed_tests = 0;
void print_result(const char *test_name, int result)
{
total_tests++;
if (result)
passed_tests++;
else
failed_tests++;
printf("%s: %s\n", test_name, result ? "通过" : "失败");
}
// 用于阻塞测试的全局变量
ring_buffer *rb_block;
// 线程1:尝试出队(缓冲区为空,应该阻塞,等到有数据后成功返回)
void *dequeue_block_thread(void *arg)
{
char out[TEST_BLOCK_SIZE];
size_t out_size = sizeof(out);
int ret = ring_buffer_read(rb_block, out, &out_size, -1); // 永久阻塞
if (ret == 0 && strcmp(out, "block") == 0)
{
printf("15. 阻塞出队线程: 成功出队数据: %s\n", out);
pthread_exit((void *)1);
}
else
{
printf("15. 阻塞出队线程: 出队失败\n");
pthread_exit((void *)0);
}
}
// 线程2:尝试入队(缓冲区已满,应该阻塞,等到有空间后成功返回)
void *enqueue_block_thread(void *arg)
{
char data[TEST_BLOCK_SIZE] = "block2";
int ret = ring_buffer_write(rb_block, data, strlen(data) + 1, -1); // 永久阻塞
if (ret == 0)
{
printf("16. 阻塞入队线程: 成功入队数据: %s\n", data);
pthread_exit((void *)1);
}
else
{
printf("16. 阻塞入队线程: 入队失败\n");
pthread_exit((void *)0);
}
}
int test()
{
ring_buffer *rb = NULL;
char data[TEST_BLOCK_SIZE];
char out[TEST_BLOCK_SIZE];
size_t out_size;
int ret;
// 初始化
rb = ring_buffer_create(TEST_CAPACITY, TEST_BLOCK_SIZE);
if (!rb)
{
printf("初始化环形缓冲区失败\n");
return -1;
}
// 检查是否为空
print_result("检查缓冲区是否为空", ring_buffer_is_empty(rb) == 1);
// 入队
strcpy(data, "hello");
ret = ring_buffer_write(rb, data, strlen(data) + 1, 0);
print_result("入队数据", ret == 0);
// 检查长度
int length = ring_buffer_length(rb);
print_result("检查缓冲区长度", length == 1);
// 出队
memset(out, 0, sizeof(out));
out_size = sizeof(out);
ret = ring_buffer_read(rb, out, &out_size, 0);
print_result("出队数据", ret == 0 && strcmp(out, "hello") == 0);
// 检查是否为空
print_result("检查缓冲区是否为空", ring_buffer_is_empty(rb) == 1);
// 多次入队
int all_ok = 1;
for (int i = 0; i < TEST_CAPACITY; ++i)
{
sprintf(data, "data%d", i);
if (ring_buffer_write(rb, data, strlen(data) + 1, 0) != 0)
{
all_ok = 0;
break;
}
}
print_result("多次入队", all_ok);
// 检查是否已满
print_result("检查缓冲区是否已满", ring_buffer_is_full(rb) == 1);
// 入队溢出测试
ret = ring_buffer_write(rb, "overflow", 9, 0);
print_result("入队溢出测试", ret < 0);
// Peek 测试
memset(out, 0, sizeof(out));
out_size = sizeof(out);
ret = ring_buffer_peek(rb, out, &out_size, 0);
print_result("Peek 测试", ret == 0 && strncmp(out, "data0", 5) == 0);
// Remove 测试
print_result("Remove 测试", ring_buffer_remove(rb) == 0);
// 检查长度
length = ring_buffer_length(rb);
print_result("检查缓冲区长度", length == TEST_CAPACITY - 1);
// 清空缓冲区
ring_buffer_clear(rb);
print_result("清空缓冲区", ring_buffer_is_empty(rb) == 1);
// 销毁缓冲区
ring_buffer_destroy(&rb);
printf("销毁缓冲区: 完成\n");
// ========== 阻塞/超时功能测试 ==========
// 出队阻塞测试
rb_block = ring_buffer_create(2, TEST_BLOCK_SIZE);
if (!rb_block)
{
printf("初始化环形缓冲区失败\n");
return -1;
}
pthread_t tid1;
void *thread_ret = NULL;
pthread_create(&tid1, NULL, dequeue_block_thread, NULL);
// 主线程睡眠1秒,确保子线程已阻塞
sleep(1);
// 入队数据,唤醒阻塞的出队线程
strcpy(data, "block");
ring_buffer_write(rb_block, data, strlen(data) + 1, 0);
pthread_join(tid1, &thread_ret);
print_result("出队阻塞测试", (int)(size_t)thread_ret == 1);
// 入队阻塞测试
// 先填满缓冲区
ring_buffer_write(rb_block, "full1", 6, 0);
ring_buffer_write(rb_block, "full2", 6, 0);
pthread_t tid2;
pthread_create(&tid2, NULL, enqueue_block_thread, NULL);
// 主线程睡眠1秒,确保子线程已阻塞
sleep(1);
// 出队一个数据,唤醒阻塞的入队线程
out_size = sizeof(out);
ring_buffer_read(rb_block, out, &out_size, 0);
pthread_join(tid2, &thread_ret);
print_result("入队阻塞测试", (int)(size_t)thread_ret == 1);
// 出队超时测试
struct timeval tv1, tv2;
long elapsed_ms;
ring_buffer_clear(rb_block); // 确保缓冲区为空
out_size = sizeof(out);
gettimeofday(&tv1, NULL);
ret = ring_buffer_read(rb_block, out, &out_size, 1000); // 1秒超时
gettimeofday(&tv2, NULL);
elapsed_ms = (tv2.tv_sec - tv1.tv_sec) * 1000 + (tv2.tv_usec - tv1.tv_usec) / 1000;
print_result("出队超时测试", ret < 0);
printf("出队超时实际耗时: %ld ms\n", elapsed_ms);
// 入队超时测试
ring_buffer_write(rb_block, "full3", 6, 0);
ring_buffer_write(rb_block, "full4", 6, 0);
gettimeofday(&tv1, NULL);
ret = ring_buffer_write(rb_block, "timeout", 8, 1000); // 1秒超时
gettimeofday(&tv2, NULL);
elapsed_ms = (tv2.tv_sec - tv1.tv_sec) * 1000 + (tv2.tv_usec - tv1.tv_usec) / 1000;
print_result("入队超时测试", ret < 0);
printf("入队超时实际耗时: %ld ms\n", elapsed_ms);
// 清理
ring_buffer_destroy(&rb_block);
return 0;
}
int main()
{
printf("==== 环形缓冲区单元测试开始 ====\n");
test();
printf("==== 环形缓冲区单元测试结束 ====\n");
// 打印统计信息
printf("==== 测试统计 ====\n");
printf("总测试数: %d\n", total_tests);
printf("成功数: %d\n", passed_tests);
printf("失败数: %d\n", failed_tests);
return 0;
}