Giter VIP home page Giter VIP logo

ring-buffer's Introduction

Ring-Buffer

A simple ring buffer (circular buffer) designed for embedded systems.

An example is given in examples/simple.c.

The size of the memory buffer must be a power-of-two, and the ring buffer can contain at most buf_size-1 bytes.

A new ring buffer is created using the ring_buffer_init(&ring_buffer, buff, sizeof(buff)) function:

char buff[64];
ring_buffer_t ring_buffer;
ring_buffer_init(&ring_buffer, buff, sizeof(buff));

In this case, the buffer size is 64 bytes and the ring buffer can contain 63 bytes.

The module provides the following functions for accessing the ring buffer (documentation can be found in ringbuffer.h):

void ring_buffer_queue(ring_buffer_t *buffer, char data);
void ring_buffer_queue_arr(ring_buffer_t *buffer, const char *data, ring_buffer_size_t size);
uint8_t ring_buffer_dequeue(ring_buffer_t *buffer, char *data);
ring_buffer_size_t ring_buffer_dequeue_arr(ring_buffer_t *buffer, char *data, ring_buffer_size_t len);
uint8_t ring_buffer_peek(ring_buffer_t *buffer, char *data, ring_buffer_size_t index);
uint8_t ring_buffer_is_empty(ring_buffer_t *buffer);
uint8_t ring_buffer_is_full(ring_buffer_t *buffer);
ring_buffer_size_t ring_buffer_num_items(ring_buffer_t *buffer);

ring-buffer's People

Contributors

5ooo avatar anderskaloer avatar ayushev avatar b4yuan avatar ballen7 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

ring-buffer's Issues

ring_buffer_num_items is wrong

The ring buffer size is 16, I add 16 elements , but the number of items is 15 .

  ring_buffer_t ring_buffer;
  char buf_arr[16];
  ring_buffer_init(&ring_buffer, buf_arr, sizeof(buf_arr));

  assert(ring_buffer_num_items(&ring_buffer) == 0);
    
  /* Add elements to buffer; one at a time */
  for(i = 0; i < 16; i++) {
    ring_buffer_queue(&ring_buffer, i);
  }

  /* Verify size */  
  assert(ring_buffer_num_items(&ring_buffer) == 16);

advise about readme

 I am very interested in this demo。I tried to go through "Readme"for more details,but nothing in it。  
Enrich the content of the document so that more readers learn more。
A great demo.

can it be used ?

Hello,

Do you recommend using the ring buffer in other applications or is it not "used" enough yet ?

Thanks,
Ran

Ring-Buffer not thread errrm interrupt-safe?

Hello,

am I right, that the ring buffer is not interrupt-safe? I've had a problem at work, that it didn't work while receiving a lot of data (1 MB) and the ring buffer is configured for 2048 bytes. The main thing was, that data is received with UART non-blocking and while data is going to be written into the buffer in the callback function new data may be received already and read from the buffer in parallel.

bool ring_buffer_read(ring_buffer_t *buffer, uint8_t *data) {
  ring_buffer_size_t tail_index = buffer->tail_index;
  ring_buffer_size_t head_index = buffer->head_index;

  if (tail_index == head_index) {
    /* No items */
    return false;
  }
  
  *data = buffer->buffer[tail_index];
  buffer->tail_index = ((tail_index + 1) & RING_BUFFER_MASK(buffer));
  return true;
}

void ring_buffer_write(ring_buffer_t *buffer, uint8_t data) {
  ring_buffer_size_t tail_index = buffer->tail_index;
  ring_buffer_size_t head_index = buffer->head_index;

  /* Is buffer full? */
  if (((head_index - tail_index) & RING_BUFFER_MASK(buffer)) == RING_BUFFER_MASK(buffer)) {
    return;
  }

  /* Place data in buffer */
  buffer->buffer[head_index] = data;
  buffer->head_index = ((head_index + 1) & RING_BUFFER_MASK(buffer));
}

I've changed a few minor things, but regarding the interrup safety, I think storing first in a local variable is key (also seen in a talk in the bare metal series on YouTube).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.