1// SPDX-License-Identifier: GPL-3.0-or-later
2
3#pragma once
4
5#include <mos/moslib_global.hpp>
6#include <mos/type_utils.hpp>
7#include <mos/types.hpp>
8
9/**
10 * @defgroup ringbuffer libs.RingBuffer
11 * @ingroup libs
12 * @brief A ring buffer.
13 * @{
14 */
15
16// A position-only ring buffer specifier.
17typedef struct _ring_buffer_pos
18{
19 size_t count = 0;
20 size_t capacity = 0;
21 size_t head = 0; // index of the first element
22 size_t next_pos = 0; // index of the next element to be inserted
23} ring_buffer_pos_t;
24
25// A managed ring buffer.
26struct ring_buffer_t : mos::NamedType<"RingBuffer">
27{
28 u8 *data;
29 ring_buffer_pos_t pos;
30};
31
32MOSAPI ring_buffer_t *ring_buffer_create(size_t capacity);
33MOSAPI ring_buffer_t *ring_buffer_create_at(void *data, size_t capacity);
34MOSAPI void ring_buffer_pos_init(ring_buffer_pos_t *pos, size_t capacity);
35MOSAPI void ring_buffer_destroy(ring_buffer_t *buffer);
36
37MOSAPI bool ring_buffer_resize(ring_buffer_t *buffer, size_t new_capacity);
38
39MOSAPI size_t ring_buffer_pos_push_back(u8 *buffer, ring_buffer_pos_t *pos, const u8 *data, size_t size);
40MOSAPI size_t ring_buffer_pos_pop_back(u8 *buffer, ring_buffer_pos_t *pos, u8 *buf, size_t size);
41
42MOSAPI size_t ring_buffer_pos_push_front(u8 *buffer, ring_buffer_pos_t *pos, const u8 *data, size_t size);
43MOSAPI size_t ring_buffer_pos_pop_front(u8 *buffer, ring_buffer_pos_t *pos, u8 *buf, size_t size);
44
45should_inline u8 ring_buffer_pos_pop_back_byte(u8 *buffer, ring_buffer_pos_t *pos)
46{
47 u8 data = '\0';
48 ring_buffer_pos_pop_back(buffer, pos, buf: &data, size: 1);
49 return data;
50}
51
52should_inline u8 ring_buffer_pos_pop_front_byte(u8 *buffer, ring_buffer_pos_t *pos)
53{
54 u8 data = '\0';
55 ring_buffer_pos_pop_front(buffer, pos, buf: &data, size: 1);
56 return data;
57}
58
59// clang-format off
60should_inline bool ring_buffer_pos_is_full(ring_buffer_pos_t *pos) { return pos->count == pos->capacity; }
61should_inline bool ring_buffer_pos_is_empty(ring_buffer_pos_t *pos) { return pos->count == 0; }
62
63should_inline size_t ring_buffer_pos_push_back_byte(u8 *buffer, ring_buffer_pos_t *pos, u8 data) { return ring_buffer_pos_push_back(buffer, pos, data: &data, size: 1); }
64should_inline size_t ring_buffer_pos_push_front_byte(u8 *buffer, ring_buffer_pos_t *pos, u8 data) { return ring_buffer_pos_push_front(buffer, pos, data: &data, size: 1); }
65
66// ring_buffer_t wrapper functions.
67
68should_inline bool ring_buffer_is_full(ring_buffer_t *buffer) { return ring_buffer_pos_is_full(pos: &buffer->pos); }
69should_inline bool ring_buffer_is_empty(ring_buffer_t *buffer) { return ring_buffer_pos_is_empty(pos: &buffer->pos); }
70
71should_inline size_t ring_buffer_push_back(ring_buffer_t *buffer, const u8 *data, size_t size) { return ring_buffer_pos_push_back(buffer: buffer->data, pos: &buffer->pos, data, size); }
72should_inline size_t ring_buffer_pop_back(ring_buffer_t *buffer, u8 *buf, size_t size) { return ring_buffer_pos_pop_back(buffer: buffer->data, pos: &buffer->pos, buf, size); }
73
74should_inline size_t ring_buffer_push_front(ring_buffer_t *buffer, const u8 *data, size_t size) { return ring_buffer_pos_push_front(buffer: buffer->data, pos: &buffer->pos, data, size); }
75should_inline size_t ring_buffer_pop_front(ring_buffer_t *buffer, u8 *buf, size_t size) { return ring_buffer_pos_pop_front(buffer: buffer->data, pos: &buffer->pos, buf, size); }
76
77should_inline size_t ring_buffer_push_front_byte(ring_buffer_t *buffer, u8 byte) { return ring_buffer_pos_push_front_byte(buffer: buffer->data, pos: &buffer->pos, data: byte); }
78
79should_inline size_t ring_buffer_push_back_byte(ring_buffer_t *buffer, u8 byte) { return ring_buffer_pos_push_back_byte(buffer: buffer->data, pos: &buffer->pos, data: byte); }
80should_inline u8 ring_buffer_pop_back_byte(ring_buffer_t *buffer) { return ring_buffer_pos_pop_back_byte(buffer: buffer->data, pos: &buffer->pos); }
81should_inline u8 ring_buffer_pop_front_byte(ring_buffer_t *buffer) { return ring_buffer_pos_pop_front_byte(buffer: buffer->data, pos: &buffer->pos); }
82// clang-format on
83/** @} */
84