Ring Buffer

• pure C++11, no OS dependency
• no exceptions, RTTI, virtual functions and dynamic memory allocation
• designed for compile time (static) allocation and type evaluation
• no wasted slots (in powers of 2 granularity)
• lock and wait free SPSC operation
• underrun and overrun checks in insert/remove functions
• highly efficient on most microcontroller architectures (nearly equal performance as in 'wasted-slot' implemetation)

notes

• index_t of size less than architecture reg size (size_t) might not be most efficient (known gcc bug)
• Only lamda expressions or functor callbacks can be inlined into buffWrite/buffRead functions
• 8 bit architectures are not supported in master branch at the moment. Broken code is likely to be generated
• relaxed atomic stores on RISC-V gcc port may be inefficient
• the DEC Alpha ultra-weak memory model is not supported

example

Ringbuffer<const char*, 256> message;

int main()
{
	//...
	while(1)
	{
		const char* tmp = nullptr;
		while(!message.remove(tmp));
		printf("%s fired\n", tmp);
		//...
	}
}

extern "C" void SysTick_Handler(void)
{
	message.insert("SysTick_Handler");
}

// if multiple contexts are writing/reading buffer they shall not be interrupting each other 
// in this case, those interrupts have to be of the same priority (nesting not allowed) 

extern "C" void USART2_IRQHandler(void)
{
	message.insert("USART2_IRQHandler");
	//...
}