hal_iobuf.h

Go to the documentation of this file.

#ifndef HAL_IOBUF_H
#define HAL_IOBUF_H

#include <stdint.h>
#include <stddef.h>



#if defined HAL_IOBUF_LIMIT_SIZE
    #if HAL_IOBUF_LIMIT_SIZE <= 8
        typedef uint_fast8_t iobuf_size_t;
    #elif HAL_IOBUF_LIMIT_SIZE <= 16
        typedef uint_fast16_t iobuf_size_t;
    #else
        typedef uint_fast32_t iobuf_size_t;
    #endif
#else
    typedef size_t iobuf_size_t;
#endif

typedef struct 
{
    iobuf_size_t elem_count;
    iobuf_size_t elem_size;
    iobuf_size_t max_elem_count;
    void* mem_ptr;
    void* read_ptr;
    void* write_ptr;
}  IOBufDesc, *IOBuf;


IOBuf IOBUF_Create(iobuf_size_t elem_size, iobuf_size_t max_elem_count);

IOBuf IOBUF_Destroy(IOBuf iobuf);

iobuf_size_t IOBUF_GetCount(IOBuf iobuf);

iobuf_size_t IOBUF_GetSpace(IOBuf iobuf);

iobuf_size_t IOBUF_GetSize(IOBuf iobuf);

IOBuf IOBUF_Init(void* buf_ptr, iobuf_size_t buf_size, iobuf_size_t elem_size);

iobuf_size_t IOBUF_Read(IOBuf iobuf, void* data, iobuf_size_t elem_count);

iobuf_size_t IOBUF_Write(IOBuf iobuf, const void* data, iobuf_size_t elem_count);

iobuf_size_t IOBUF_ReadNextFragment(IOBuf iobuf, iobuf_size_t fragment_size, void** next_fragment_ptr, iobuf_size_t* next_fragment_size);

iobuf_size_t IOBUF_WriteNextFragment(IOBuf iobuf, iobuf_size_t fragment_size, void** next_fragment_ptr, iobuf_size_t* next_fragment_size);

iobuf_size_t IOBUF_ReadFast(IOBuf iobuf, void* elem);

iobuf_size_t IOBUF_WriteFast(IOBuf iobuf, const void* elem);

void IOBUF_Clear(IOBuf iobuf);

iobuf_size_t IOBUF_Peek(IOBuf iobuf, void* data, iobuf_size_t elem_count);


iobuf_size_t IOBUF_Move(IOBuf dst_iobuf, IOBuf src_iobuf, iobuf_size_t elem_count);


iobuf_size_t IOBUF_Remove(IOBuf iobuf, iobuf_size_t elem_count);


#define IOBUF_DECLARE(name, count, size)             \
    static uint8_t name##_mempool[(count)*(size)]; \
    static IOBufDesc name = { 0, size, count, &name##_mempool, &name##_mempool, &name##_mempool };

#endif /* hal_iobuf_h */