笨办法学C 练习44：环形缓冲区

2016-06-21 17:40:00

练习44：环形缓冲区

原文：Exercise 44: Ring Buffer

译者：飞龙

环形缓冲区在处理异步IO时非常实用。它们可以在一段接收随机长度和区间的数据，在另一端以相同长度和区间提供密致的数据块。它们是Queue数据结构的变体，但是它针对于字节块而不是一系列指针。这个练习中我打算想你展示RingBuffer的代码，并且之后你需要对它执行完整的单元测试。

# ifndef _lcthw_RingBuffer_h# define _lcthw_RingBuffer_h# include typedef struct {    char *buffer;    int length;    int start;    int end;} RingBuffer;RingBuffer *RingBuffer_create(int length);void RingBuffer_destroy(RingBuffer *buffer);int RingBuffer_read(RingBuffer *buffer, char *target, int amount);int RingBuffer_write(RingBuffer *buffer, char *data, int length);int RingBuffer_empty(RingBuffer *buffer);int RingBuffer_full(RingBuffer *buffer);int RingBuffer_available_data(RingBuffer *buffer);int RingBuffer_available_space(RingBuffer *buffer);bstring RingBuffer_gets(RingBuffer *buffer, int amount);# define RingBuffer_available_data(B) (((B)->end + 1) % (B)->length - (B)->start - 1)# define RingBuffer_available_space(B) ((B)->length - (B)->end - 1)# define RingBuffer_full(B) (RingBuffer_available_data((B)) - (B)->length == 0)# define RingBuffer_empty(B) (RingBuffer_available_data((B)) == 0)# define RingBuffer_puts(B, D) RingBuffer_write((B), bdata((D)), blength((D)))# define RingBuffer_get_all(B) RingBuffer_gets((B), RingBuffer_available_data((B)))# define RingBuffer_starts_at(B) ((B)->buffer + (B)->start)# define RingBuffer_ends_at(B) ((B)->buffer + (B)->end)# define RingBuffer_commit_read(B, A) ((B)->start = ((B)->start + (A)) % (B)->length)# define RingBuffer_commit_write(B, A) ((B)->end = ((B)->end + (A)) % (B)->length)# endif

观察这个数据结构，你会看到它含有buffer、start 和 end。RingBuffer的所做的事情只是在buffer中移动start和end，所以当数据到达缓冲区末尾时还可以继续“循环”。这样就会给人一种在固定空间内无限读取的“幻觉”。接下来我创建了一些宏来基于它执行各种计算。

下面是它的实现，它是对工作原理更好的解释：

# undef NDEBUG# include # include # include # include # include # include RingBuffer *RingBuffer_create(int length){    RingBuffer *buffer = calloc(1, sizeof(RingBuffer));    buffer->length  = length + 1;    buffer->start = 0;    buffer->end = 0;    buffer->buffer = calloc(buffer->length, 1);    return buffer;}void RingBuffer_destroy(RingBuffer *buffer){    if(buffer) {        free(buffer->buffer);        free(buffer);    }}int RingBuffer_write(RingBuffer *buffer, char *data, int length){    if(RingBuffer_available_data(buffer) == 0) {        buffer->start = buffer->end = 0;    }    check(length end == buffer->start) {        buffer->start = buffer->end = 0;    }    return amount;error:    return -1;}bstring RingBuffer_gets(RingBuffer *buffer, int amount){    check(amount > 0, "Need more than 0 for gets, you gave: %d ", amount);    check_debug(amount = 0 && "Error in read commit.");    return result;error:    return NULL;}

这些就是一个基本的RingBuffer实现的全部了。你可以从中读取和写入数据，获得它的大小和容量。也有一些缓冲区使用OS中的技巧来创建虚拟的无限存储，但它们不可移植。

由于我的RingBuffer处理读取和写入内存块，我要保证任何end == start出现的时候我都要将它们重置为0，使它们从退回缓冲区头部。在维基百科上的版本中，它并不可以写入数据块，所以只能移动end和start来转圈。为了更好地处理数据块，你需要在数据为空时移动到内部缓冲区的开头。

单元测试

对于你的单元测试，你需要测试尽可能多的情况。最简单的方法就是预构造不同的RingBuffer结构，之后手动检查函数和算数是否有效。例如，你可以构造end在缓冲区末尾的右边，而start在缓冲区范围内的RingBuffer，来看看它是否执行成功。

你会看到什么

下面是我的ringbuffer_tests运行结果：

$ ./tests/ringbuffer_testsDEBUG tests/ringbuffer_tests.c:60: ----- RUNNING: ./tests/ringbuffer_tests----RUNNING: ./tests/ringbuffer_testsDEBUG tests/ringbuffer_tests.c:53: ----- test_createDEBUG tests/ringbuffer_tests.c:54: ----- test_read_writeDEBUG tests/ringbuffer_tests.c:55: ----- test_destroyALL TESTS PASSEDTests run: 3$

你应该测试至少三次来确保所有基本操作有效，并且看看在我完成之前你能测试到额外的多少东西。