65 lines
1.8 KiB
C
65 lines
1.8 KiB
C
/* SPDX-License-Identifier: MIT */
|
|
|
|
#pragma once
|
|
|
|
#ifndef rb_size_t
|
|
#define rb_size_t int
|
|
#endif
|
|
|
|
/** Signatures of allocators */
|
|
typedef void *(*ALLOC_T)(rb_size_t);
|
|
|
|
/** Signature of memcpy */
|
|
typedef void *(*MEMCPY_T)(void *, const void *, rb_size_t);
|
|
|
|
/**
|
|
* @brief Ring buffer, also known as circular buffer.
|
|
*/
|
|
struct RingBuf {
|
|
rb_size_t struct_size; /** Size of the struct */
|
|
rb_size_t capacity; /** The physical capacity of the entire ringbuf */
|
|
rb_size_t count; /** The number of elements in the buffer */
|
|
void *write_head; /** Address of the write head */
|
|
void *read_head; /** Address of the read head */
|
|
void *buffer; /** The actual data */
|
|
void *buffer_end; /** The end of the buffer */
|
|
} __attribute__((packed));
|
|
|
|
enum WriteResult { Full, WriteOk }; /** Result of a write */
|
|
enum ReadResult { Empty, ReadOk }; /** Result of a read */
|
|
|
|
/**
|
|
* @brief Initialize the ring buffer
|
|
* @param rb The ring buffer to initialize
|
|
* @param capacity The capacity of the ring buffer
|
|
* @param alloc The allocator function
|
|
* @param struct_size The size of the struct
|
|
* @return void
|
|
*/
|
|
void rb_init(struct RingBuf *rb, rb_size_t capacity, ALLOC_T alloc,
|
|
rb_size_t struct_size);
|
|
|
|
/**
|
|
* @brief Insert data to the ring buffer
|
|
* @param rb The ring buffer
|
|
* @param item The item to insert
|
|
* @param memcpy_fn The memcpy function
|
|
* @return WriteResult
|
|
*/
|
|
enum WriteResult rb_push_back(struct RingBuf *rb, const void *item,
|
|
MEMCPY_T memcpy_fn);
|
|
|
|
/**
|
|
* @brief Read data from the ring buffer
|
|
* @param rb The ring buffer
|
|
* @param item The item to read into
|
|
* @return ReadResult
|
|
*/
|
|
enum ReadResult rb_pop_front(struct RingBuf *rb, void *item);
|
|
|
|
/**
|
|
* @brief Free the ring buffer
|
|
* @param rb The ring buffer
|
|
* @param free The free function
|
|
*/
|
|
void rb_destroy(struct RingBuf *rb, void(free)());
|