wow-ring-buff环形缓冲区操作说明

wow-ring-buff文件说明

• 项目地址：https://gitee.com/wow-iot/wow-iot7
• 本文件的的功能主要实现数据环形缓冲区相关功能，包括创建、删除、读、写、清除、查看已用空间、查看可用空间；

创建环形缓冲区

RingBuffer_T* wow_ringbuf_create(size_t snSize)
{
	RingBuffer_T* rbuf = CALLOC(1, RingBuffer_T);
	CHECK_RET_VAL_ERRNO_P(rbuf,-SYSTEM_MALLOC_FAILED,"malloc RingBuffer_T faild!\n");
	memset(rbuf,0,sizeof(RingBuffer_T));
	
	rbuf->length = snSize;
	rbuf->start  = 0;
	rbuf->end    = 0;
	rbuf->buffer = MALLOC(snSize);
	memset(rbuf->buffer,0,snSize);
	CHECK_RET_GOTO_ERRNO_P(rbuf->buffer,out,-SYSTEM_MALLOC_FAILED,"malloc size(%zu) failed!\n",snSize);
	
	return (RingBuffer_T*)rbuf;
out:
	FREE(rbuf);
	return NULL;
}

销毁环形缓冲区

void wow_ringbuf_destroy(RingBuffer_T** pptRbuf)
{
	CHECK_RET_VOID(pptRbuf && *pptRbuf);
	RingBuffer_T* rbuf = (RingBuffer_T*)*pptRbuf;
	
	if(rbuf->buffer){
		FREE(rbuf->buffer);
	}
	rbuf->buffer = NULL;
	
	FREE(rbuf);
	*pptRbuf = NULL;
}

向环形缓冲区写入内容

int wow_ringbuf_write(RingBuffer_T* ptRbuf, const void *data, size_t snSize)
{
	CHECK_RET_VAL_P(ptRbuf, -PARAM_INPUT_STRUCT_IS_NULL,"param input struct invalid!\n");
	CHECK_RET_VAL_P(data, -PARAM_INPUT_DATA_IS_NULL, "param input data invalid!\n");
	CHECK_RET_VAL_P(snSize > 0, -PARAM_INPUT_ARG_INVALID, "param input arg invalid!\n");

	size_t left = wow_ringbuf_getFree(ptRbuf);
	CHECK_RET_VAL(left > snSize, -RING_BUFFER_NO_SPACE);

	if ((ptRbuf->length - ptRbuf->end) < snSize) {
    	int half_tail = ptRbuf->length - ptRbuf->end;
    	memcpy(ringbuf_end_ptr(ptRbuf), data, half_tail);
    	ptRbuf->end = (ptRbuf->end + half_tail) % ptRbuf->length;

    	int half_head = snSize - half_tail;
    	memcpy(ringbuf_end_ptr(ptRbuf), data+half_tail, half_head);
    	ptRbuf->end = (ptRbuf->end + half_head) % ptRbuf->length;
	} else {
    	memcpy(ringbuf_end_ptr(ptRbuf), data, snSize);
    	ptRbuf->end = (ptRbuf->end + snSize) % ptRbuf->length;
	}
	
	return snSize;
}

从环形缓冲区读取内容

int wow_ringbuf_read(RingBuffer_T* ptRbuf, void *data, size_t snSize)
{
	CHECK_RET_VAL_P(ptRbuf, -PARAM_INPUT_STRUCT_IS_NULL,"param input struct invalid!\n");
	CHECK_RET_VAL_P(data, -PARAM_INPUT_DATA_IS_NULL, "param input data invalid!\n");
	CHECK_RET_VAL_P(snSize > 0, -PARAM_INPUT_ARG_INVALID, "param input arg invalid!\n");

	size_t rlen = MIN2(snSize, wow_ringbuf_getUsed(ptRbuf));

	if ((ptRbuf->length - ptRbuf->start) < rlen) {
    	int half_tail = ptRbuf->length - ptRbuf->start;
    	memcpy(data, ringbuf_start_ptr(ptRbuf), half_tail);
    	ptRbuf->start = (ptRbuf->start + half_tail) % ptRbuf->length;

    	int half_head = rlen - half_tail;
    	memcpy(data+half_tail, ringbuf_start_ptr(ptRbuf), half_head);
    	ptRbuf->start = (ptRbuf->start + half_head) % ptRbuf->length;
	} else {
    	memcpy(data, ringbuf_start_ptr(ptRbuf), rlen);
    	ptRbuf->start = (ptRbuf->start + rlen) % ptRbuf->length;
	}

	if ((ptRbuf->start == ptRbuf->end) || (wow_ringbuf_getUsed(ptRbuf) == 0)) {
    	ptRbuf->start = ptRbuf->end = 0;
	}
	
	return rlen;
}

清空环形缓冲区

void wow_ringbuf_clear(RingBuffer_T* ptRbuf)
{
	CHECK_RET_VOID(ptRbuf);
	
	ptRbuf->start = ptRbuf->end = 0;
}