Single-Producer Single-Consumer Lock-Free FIFO Ring

include/structures/spsc_fifo_ring.h View source View on GitHub

Structs

struct spsc_fifo_ring (5 fields)

§ atomic_size_t head

Written by Producer

§ atomic_size_t tail

Written by Consumer

§ size_t size

Capacity (pow2)

§ size_t mask

size - 1

§ uint8_t *data

bool spsc_fifo_ring_init(struct spsc_fifo_ring *fifo, size_t size)

(rounded to power of 2)

void spsc_fifo_ring_init_with(
    struct spsc_fifo_ring *fifo,
    void *buffer,
    size_t size
)

void spsc_fifo_ring_destroy(struct spsc_fifo_ring *fifo)

size_t spsc_fifo_ring_write(
    struct spsc_fifo_ring *fifo,
    const void *src,
    size_t len
)

size_t spsc_fifo_ring_read(
    struct spsc_fifo_ring *fifo,
    void *dst,
    size_t len
)

size_t spsc_fifo_ring_peek(
    const struct spsc_fifo_ring *fifo,
    void *dst,
    size_t len
)

peek up to len bytes into dst without consuming

bool spsc_fifo_ring_push_ptr(
    struct spsc_fifo_ring *fifo,
    const void *ptr
)

bool spsc_fifo_ring_pop_ptr(
    struct spsc_fifo_ring *fifo,
    void **out_ptr
)

size_t spsc_fifo_ring_len(const struct spsc_fifo_ring *fifo)

size_t spsc_fifo_ring_avail(const struct spsc_fifo_ring *fifo)

bool spsc_fifo_ring_is_empty(const struct spsc_fifo_ring *fifo)

bool spsc_fifo_ring_is_full(const struct spsc_fifo_ring *fifo)

void spsc_fifo_ring_reset(struct spsc_fifo_ring *fifo)

#define SPSC_FIFO_RING_INIT

Expansion

#define SPSC_FIFO_RING_INIT \
    (struct spsc_fifo_ring) { \
        .head = 0, .tail = 0, .size = 0, .mask = 0, .data = NULL \
    }