cbuffer.h File Reference

#include <stdarg.h>
#include <zrtos/types.h>
#include <zrtos/error.h>
#include <zrtos/list.h>
#include <zrtos/malloc_limit.h>
#include <zrtos/assert.h>
#include <zrtos/cast.h>

Include dependency graph for cbuffer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	_zrtos_cbuffer_node_t
struct	_zrtos_cbuffer_t
struct	_zrtos_cbuffer_write_transaction_t

Macros
#define	ZRTOS_CBUFFER__CFG_DATA_LENGTH   16
#define	ZRTOS_CBUFFER__CFG_MALLOC_LIMIT   200

Typedefs
typedef struct _zrtos_cbuffer_node_t	zrtos_cbuffer_node_t
typedef struct _zrtos_cbuffer_t	zrtos_cbuffer_t
typedef struct _zrtos_cbuffer_write_transaction_t	zrtos_cbuffer_write_transaction_t

Functions
	ZRTOS_ASSERT__STATIC_IS_POWER_OF_TWO (ZRTOS_CBUFFER__CFG_DATA_LENGTH)
zrtos_cbuffer_node_t *	zrtos_cbuffer__get_first_node (zrtos_cbuffer_t *thiz)
zrtos_cbuffer_node_t *	zrtos_cbuffer__get_last_node (zrtos_cbuffer_t *thiz)
zrtos_cbuffer_node_t *	zrtos_cbuffer_node__get_next_node (zrtos_cbuffer_node_t *thiz)
bool	zrtos_cbuffer_node__init (zrtos_cbuffer_node_t *thiz, zrtos_cbuffer_t *ctx)
zrtos_cbuffer_node_t *	zrtos_cbuffer_node__new (zrtos_cbuffer_t *ctx)
void	zrtos_cbuffer_node__free (zrtos_cbuffer_node_t *thiz, zrtos_cbuffer_t *ctx)
bool	zrtos_cbuffer__init (zrtos_cbuffer_t *thiz)
void	zrtos_cbuffer__deinit_callback (zrtos_list_t *thiz, zrtos_list_node_t *node)
void	zrtos_cbuffer__deinit (zrtos_cbuffer_t *thiz)
void	zrtos_cbuffer__start_write_transaction (zrtos_cbuffer_t *thiz, zrtos_cbuffer_write_transaction_t *txn)
void	zrtos_cbuffer__rollback_write_transaction (zrtos_cbuffer_t *thiz, zrtos_cbuffer_write_transaction_t *txn)
static size_t	zrtos_cbuffer_node__get_length (zrtos_cbuffer_node_t *thiz)
bool	zrtos_cbuffer_node__is_empty (zrtos_cbuffer_node_t *thiz)
static size_t	zrtos_cbuffer_node__get_free_space (zrtos_cbuffer_node_t *thiz)
zrtos_error_t	zrtos_cbuffer_node__put (zrtos_cbuffer_node_t *thiz, zrtos_cbuffer_t *ctx, uint8_t val)
zrtos_error_t	zrtos_cbuffer_node__get (zrtos_cbuffer_node_t *thiz, zrtos_cbuffer_t *ctx, uint8_t *out)
zrtos_error_t	zrtos_cbuffer_node__peek (zrtos_cbuffer_node_t *thiz, uint8_t *out)
zrtos_error_t	zrtos_cbuffer__hash (zrtos_cbuffer_t *thiz, size_t length, void(*callback)(void *callback_args, uint8_t ch), void *callback_args)
zrtos_error_t	zrtos_cbuffer__put (zrtos_cbuffer_t *thiz, uint8_t val)
zrtos_error_t	zrtos_cbuffer__put_ex (zrtos_cbuffer_t *thiz, size_t len, size_t *outlen,...)
zrtos_error_t	zrtos_cbuffer__peek (zrtos_cbuffer_t *thiz, uint8_t *out)
zrtos_error_t	zrtos_cbuffer__get (zrtos_cbuffer_t *thiz, uint8_t *out)
zrtos_error_t	zrtos_cbuffer__get_ex (zrtos_cbuffer_t *thiz, void *data, size_t len, size_t *outlen)
zrtos_error_t	zrtos_cbuffer__pop (zrtos_cbuffer_t *thiz)
bool	zrtos_cbuffer__is_empty (zrtos_cbuffer_t *thiz)
void	zrtos_cbuffer__clear (zrtos_cbuffer_t *thiz)
zrtos_error_t	zrtos_cbuffer__can_read (zrtos_cbuffer_t *thiz)
bool	zrtos_cbuffer__can_read_length (zrtos_cbuffer_t *thiz, size_t length)
size_t	zrtos_cbuffer__get_length (zrtos_cbuffer_t *thiz)
zrtos_error_t	zrtos_cbuffer__can_write (zrtos_cbuffer_t *thiz)
zrtos_error_t	zrtos_cbuffer__pipe (zrtos_cbuffer_t *thiz, zrtos_cbuffer_t *src, size_t length, size_t *outlen)

Variables
zrtos_malloc_limit_t	zrtos_cbuffer__malloc_limit = ZRTOS_MALLOC_LIMIT__INIT()

Macro Definition Documentation

ZRTOS_CBUFFER__CFG_DATA_LENGTH

#define ZRTOS_CBUFFER__CFG_DATA_LENGTH   16

Definition at line 25 of file cbuffer.h.

ZRTOS_CBUFFER__CFG_MALLOC_LIMIT

#define ZRTOS_CBUFFER__CFG_MALLOC_LIMIT   200

Definition at line 29 of file cbuffer.h.

Typedef Documentation

zrtos_cbuffer_node_t

typedef struct _zrtos_cbuffer_node_t zrtos_cbuffer_node_t

zrtos_cbuffer_t

typedef struct _zrtos_cbuffer_t zrtos_cbuffer_t

zrtos_cbuffer_write_transaction_t

typedef struct _zrtos_cbuffer_write_transaction_t zrtos_cbuffer_write_transaction_t

Function Documentation

ZRTOS_ASSERT__STATIC_IS_POWER_OF_TWO()

ZRTOS_ASSERT__STATIC_IS_POWER_OF_TWO

(

ZRTOS_CBUFFER__CFG_DATA_LENGTH

)

zrtos_cbuffer__can_read()

zrtos_error_t zrtos_cbuffer__can_read

(

zrtos_cbuffer_t *

thiz

)

Definition at line 373 of file cbuffer.h.

 {
    return zrtos_cbuffer__is_empty(thiz)
         ? ZRTOS_ERROR__AGAIN
         : ZRTOS_ERROR__SUCCESS
    ;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer__can_read_length()

bool zrtos_cbuffer__can_read_length	(	zrtos_cbuffer_t *	thiz,
		size_t	length
	)

Definition at line 382 of file cbuffer.h.

 {
    zrtos_cbuffer_node_t *node = zrtos_cbuffer__get_first_node(thiz);

    while(node
    && length
    && !zrtos_cbuffer_node__is_empty(node)){
        length -= ZRTOS_TYPES__MIN(
             ((size_t)(node->head - node->tail))
            ,length
        );
        node = zrtos_cbuffer_node__get_next_node(node);
    }

    return length == 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer__can_write()

zrtos_error_t zrtos_cbuffer__can_write

(

zrtos_cbuffer_t *

thiz

)

Definition at line 415 of file cbuffer.h.

 {
    return ZRTOS_ERROR__SUCCESS;
}

Here is the caller graph for this function:

zrtos_cbuffer__clear()

void zrtos_cbuffer__clear

(

zrtos_cbuffer_t *

thiz

)

Definition at line 362 of file cbuffer.h.

                                                {
    zrtos_cbuffer_node_t *node = zrtos_cbuffer__get_first_node(thiz);

    while(zrtos_list_node__has_next_node(&node->node)){
        zrtos_cbuffer_node__free(node,thiz);
        node = zrtos_cbuffer__get_first_node(thiz);
    }

    node->head = node->tail = 0;
}

Here is the call graph for this function:

zrtos_cbuffer__deinit()

void zrtos_cbuffer__deinit

(

zrtos_cbuffer_t *

thiz

)

Definition at line 140 of file cbuffer.h.

 {
    zrtos_list__deinit(&thiz->root,zrtos_cbuffer__deinit_callback);
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer__deinit_callback()

void zrtos_cbuffer__deinit_callback	(	zrtos_list_t *	thiz,
		zrtos_list_node_t *	node
	)

Definition at line 122 of file cbuffer.h.

 {
    zrtos_cbuffer_node__free(
        zrtos_types__get_container_of(
             node
            ,zrtos_cbuffer_node_t
            ,node
        )
        ,zrtos_types__get_container_of(
             thiz
            ,zrtos_cbuffer_t
            ,root
        )
    );
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer__get()

zrtos_error_t zrtos_cbuffer__get	(	zrtos_cbuffer_t *	thiz,
		uint8_t *	out
	)

Definition at line 327 of file cbuffer.h.

                                                                    {
    zrtos_cbuffer_node_t *node = zrtos_types__get_container_of(
         zrtos_list__get_first_node(&thiz->root)
        ,zrtos_cbuffer_node_t
        ,node
    );
    return zrtos_cbuffer_node__get(node,thiz,out);
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer__get_ex()

zrtos_error_t zrtos_cbuffer__get_ex	(	zrtos_cbuffer_t *	thiz,
		void *	data,
		size_t	len,
		size_t *	outlen
	)

Definition at line 336 of file cbuffer.h.

 {
    zrtos_error_t ret = ZRTOS_ERROR__SUCCESS;
    uint8_t *tmp = ZRTOS_CAST(uint8_t*,data);
    while(len--
       && ZRTOS_ERROR__SUCCESS == (ret = zrtos_cbuffer__get(thiz,tmp++))){
        ;
    }
    *outlen = zrtos_types__ptr_get_byte_distance(tmp,data);
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer__get_first_node()

zrtos_cbuffer_node_t* zrtos_cbuffer__get_first_node

(

zrtos_cbuffer_t *

thiz

)

Definition at line 57 of file cbuffer.h.

                                                                          {
    zrtos_cbuffer_node_t *node = zrtos_types__get_container_of(
         zrtos_list__get_first_node(&thiz->root)
        ,zrtos_cbuffer_node_t
        ,node
    );
    return node;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer__get_last_node()

zrtos_cbuffer_node_t* zrtos_cbuffer__get_last_node

(

zrtos_cbuffer_t *

thiz

)

Definition at line 66 of file cbuffer.h.

                                                                         {
    zrtos_cbuffer_node_t *node = zrtos_types__get_container_of(
         zrtos_list__get_last_node(&thiz->root)
        ,zrtos_cbuffer_node_t
        ,node
    );
    return node;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer__get_length()

size_t zrtos_cbuffer__get_length

(

zrtos_cbuffer_t *

thiz

)

Definition at line 401 of file cbuffer.h.

 {
    zrtos_cbuffer_node_t *node = zrtos_cbuffer__get_first_node(thiz);
    size_t length = 0;

    while(node){
        length += zrtos_cbuffer_node__get_length(node);
        node = zrtos_cbuffer_node__get_next_node(node);
    }

    return length == 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer__hash()

zrtos_error_t zrtos_cbuffer__hash	(	zrtos_cbuffer_t *	thiz,
		size_t	length,
		void(*)(void *callback_args, uint8_t ch)	callback,
		void *	callback_args
	)

Definition at line 245 of file cbuffer.h.

 {
    zrtos_cbuffer_node_t *node = zrtos_cbuffer__get_first_node(thiz);
    size_t tail;
    size_t head;

    while(node && length){
        head = node->head;
        tail = node->tail;

        while(tail != head && length--){
            callback(callback_args,node->data[tail++]);
        }

        node = zrtos_cbuffer_node__get_next_node(node);
    }

    return length == 0 ? ZRTOS_ERROR__SUCCESS : ZRTOS_ERROR__INVAL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer__init()

bool zrtos_cbuffer__init

(

zrtos_cbuffer_t *

thiz

)

Definition at line 115 of file cbuffer.h.

 {
    zrtos_list__init(&thiz->root);
    return zrtos_cbuffer_node__new(thiz) != 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer__is_empty()

bool zrtos_cbuffer__is_empty

(

zrtos_cbuffer_t *

thiz

)

Definition at line 357 of file cbuffer.h.

                                                   {
    zrtos_cbuffer_node_t *node = zrtos_cbuffer__get_first_node(thiz);
    return zrtos_cbuffer_node__is_empty(node);
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer__peek()

zrtos_error_t zrtos_cbuffer__peek	(	zrtos_cbuffer_t *	thiz,
		uint8_t *	out
	)

Definition at line 318 of file cbuffer.h.

                                                                     {
    zrtos_cbuffer_node_t *node = zrtos_types__get_container_of(
         zrtos_list__get_first_node(&thiz->root)
        ,zrtos_cbuffer_node_t
        ,node
    );
    return zrtos_cbuffer_node__peek(node,out);
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer__pipe()

zrtos_error_t zrtos_cbuffer__pipe	(	zrtos_cbuffer_t *	thiz,
		zrtos_cbuffer_t *	src,
		size_t	length,
		size_t *	outlen
	)

Definition at line 421 of file cbuffer.h.

 {
    zrtos_error_t ret = ZRTOS_ERROR__SUCCESS;
    uint8_t tmp;

    *outlen = length;

    while(length){
        if(zrtos_error__is_success((ret = zrtos_cbuffer__peek(src,&tmp)))
        && zrtos_error__is_success((ret = zrtos_cbuffer__put(thiz,tmp)))
        ){
            length--;
            zrtos_cbuffer__pop(src);
        }else{
            break;
        }
    }

    *outlen -= length;

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer__pop()

zrtos_error_t zrtos_cbuffer__pop

(

zrtos_cbuffer_t *

thiz

)

Definition at line 352 of file cbuffer.h.

                                                       {
    uint8_t out;
    return zrtos_cbuffer__get(thiz,&out);
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer__put()

zrtos_error_t zrtos_cbuffer__put	(	zrtos_cbuffer_t *	thiz,
		uint8_t	val
	)

Definition at line 269 of file cbuffer.h.

                                                                   {
    zrtos_cbuffer_node_t *node = zrtos_types__get_container_of(
         zrtos_list__get_last_node(&thiz->root)
        ,zrtos_cbuffer_node_t
        ,node
    );
    return zrtos_cbuffer_node__put(node,thiz,val);
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer__put_ex()

zrtos_error_t zrtos_cbuffer__put_ex	(	zrtos_cbuffer_t *	thiz,
		size_t	len,
		size_t *	outlen,
			...
	)

Definition at line 278 of file cbuffer.h.

 {
    zrtos_error_t ret = ZRTOS_ERROR__SUCCESS;
    uint8_t *data;
    size_t data_len;
    va_list args;
    zrtos_cbuffer_write_transaction_t txn;

    va_start(args,outlen);

    zrtos_cbuffer__start_write_transaction(thiz,&txn);

    while(len-- && zrtos_error__is_success(ret)){
        data = ZRTOS_CAST(uint8_t*,va_arg(args,void*));
        data_len = va_arg(args,size_t);
        while(data_len-- && zrtos_error__is_success(ret)){
            ret = zrtos_cbuffer__put(
                 thiz
                ,*data++
            );
        }
    }

    if(zrtos_error__is_error(ret)){
        zrtos_cbuffer__rollback_write_transaction(thiz,&txn);
    }

    va_end(args);

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer__rollback_write_transaction()

void zrtos_cbuffer__rollback_write_transaction	(	zrtos_cbuffer_t *	thiz,
		zrtos_cbuffer_write_transaction_t *	txn
	)

Definition at line 154 of file cbuffer.h.

 {
    zrtos_cbuffer_node_t *next;
    zrtos_cbuffer_node_t *node = zrtos_cbuffer__get_last_node(&txn->thiz);
    node->head = txn->head;
    while((next = zrtos_cbuffer_node__get_next_node(node))){
        zrtos_cbuffer_node__free(
             next
            ,thiz
        );
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer__start_write_transaction()

void zrtos_cbuffer__start_write_transaction	(	zrtos_cbuffer_t *	thiz,
		zrtos_cbuffer_write_transaction_t *	txn
	)

Definition at line 146 of file cbuffer.h.

 {
    txn->thiz = *thiz;
    txn->head = zrtos_cbuffer__get_last_node(thiz)->head;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer_node__free()

void zrtos_cbuffer_node__free	(	zrtos_cbuffer_node_t *	thiz,
		zrtos_cbuffer_t *	ctx
	)

Definition at line 110 of file cbuffer.h.

                                                                              {
    zrtos_list__delete(&ctx->root,&thiz->node);
    zrtos_malloc_limit__free(&zrtos_cbuffer__malloc_limit,thiz);
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer_node__get()

zrtos_error_t zrtos_cbuffer_node__get	(	zrtos_cbuffer_node_t *	thiz,
		zrtos_cbuffer_t *	ctx,
		uint8_t *	out
	)

Definition at line 213 of file cbuffer.h.

 {
    zrtos_error_t ret = ZRTOS_ERROR__SUCCESS;
    if(!zrtos_cbuffer_node__is_empty(thiz)){
        *out = thiz->data[thiz->tail++];
        thiz->tail &= (ZRTOS_CBUFFER__CFG_DATA_LENGTH - 1);
        if(zrtos_cbuffer_node__is_empty(thiz)
        && zrtos_list_node__has_next_node(&thiz->node)){
            zrtos_cbuffer_node__free(thiz,ctx);
        }
    }else{
        ret = ZRTOS_ERROR__AGAIN;
    }
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer_node__get_free_space()

static size_t zrtos_cbuffer_node__get_free_space ( zrtos_cbuffer_node_t *  thiz )

static

Definition at line 180 of file cbuffer.h.

 {
    return (ZRTOS_CBUFFER__CFG_DATA_LENGTH - 1)
         - zrtos_cbuffer_node__get_length(thiz)
    ;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer_node__get_length()

static size_t zrtos_cbuffer_node__get_length ( zrtos_cbuffer_node_t *  thiz )

static

Definition at line 169 of file cbuffer.h.

 {
    return (thiz->head - thiz->tail) & (ZRTOS_CBUFFER__CFG_DATA_LENGTH - 1);
}

Here is the caller graph for this function:

zrtos_cbuffer_node__get_next_node()

zrtos_cbuffer_node_t* zrtos_cbuffer_node__get_next_node

(

zrtos_cbuffer_node_t *

thiz

)

Definition at line 75 of file cbuffer.h.

                                                                                   {
    zrtos_cbuffer_node_t *node = zrtos_types__get_container_of(
         zrtos_list_node__get_next_node(&thiz->node)
        ,zrtos_cbuffer_node_t
        ,node
    );
    return node;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer_node__init()

bool zrtos_cbuffer_node__init	(	zrtos_cbuffer_node_t *	thiz,
		zrtos_cbuffer_t *	ctx
	)

Definition at line 84 of file cbuffer.h.

 {
    zrtos_list_node__init(&thiz->node);
    zrtos_list__push(&ctx->root,&thiz->node);
    thiz->head = 0;
    thiz->tail = 0;
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer_node__is_empty()

bool zrtos_cbuffer_node__is_empty

(

zrtos_cbuffer_node_t *

thiz

)

Definition at line 175 of file cbuffer.h.

                                                             {
    //return zrtos_cbuffer_node__get_length(thiz) == 0;
    return thiz->head == thiz->tail;
}

Here is the caller graph for this function:

zrtos_cbuffer_node__new()

zrtos_cbuffer_node_t* zrtos_cbuffer_node__new

(

zrtos_cbuffer_t *

ctx

)

Definition at line 95 of file cbuffer.h.

                                                                   {
    zrtos_cbuffer_node_t *ret = ZRTOS_CAST(
         zrtos_cbuffer_node_t*
        ,zrtos_malloc_limit__malloc(
            &zrtos_cbuffer__malloc_limit
            ,sizeof(zrtos_cbuffer_node_t)
            ,ZRTOS_CBUFFER__CFG_MALLOC_LIMIT
        )
    );
    if(ret){
        zrtos_cbuffer_node__init(ret,ctx);
    }
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer_node__peek()

zrtos_error_t zrtos_cbuffer_node__peek	(	zrtos_cbuffer_node_t *	thiz,
		uint8_t *	out
	)

Definition at line 232 of file cbuffer.h.

 {
    zrtos_error_t ret = ZRTOS_ERROR__SUCCESS;
    if(!zrtos_cbuffer_node__is_empty(thiz)){
        *out = thiz->data[thiz->tail];
    }else{
        ret = ZRTOS_ERROR__AGAIN;
    }
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_cbuffer_node__put()

zrtos_error_t zrtos_cbuffer_node__put	(	zrtos_cbuffer_node_t *	thiz,
		zrtos_cbuffer_t *	ctx,
		uint8_t	val
	)

Definition at line 188 of file cbuffer.h.

 {
    zrtos_error_t ret = ZRTOS_ERROR__SUCCESS;

    if(zrtos_cbuffer_node__get_free_space(thiz) >= 1){
        thiz->data[thiz->head++] = val;
        thiz->head &= (ZRTOS_CBUFFER__CFG_DATA_LENGTH - 1);
    }else{
        zrtos_cbuffer_node_t *node = zrtos_cbuffer_node__new(ctx);
        if(node){
            ret = zrtos_cbuffer_node__put(
                 node
                ,ctx
                ,val
            );
        }else{
            ret = ZRTOS_ERROR__NOMEM;
        }
    }
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

zrtos_cbuffer__malloc_limit

zrtos_malloc_limit_t zrtos_cbuffer__malloc_limit = ZRTOS_MALLOC_LIMIT__INIT()

Todo:

mutex lock zrtos_cbuffer__malloc_limit

Definition at line 55 of file cbuffer.h.