Return to aring.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / libelwix / inc / elwix

Version 6.14

/*************************************************************************
* (C) 2025 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
*  by Michael Pounov <misho@elwix.org>
*
* $Author: misho $
* $Id: aring.h,v 1.6 2026/02/11 13:36:09 misho Exp $
*
**************************************************************************
The ELWIX and AITNET software is distributed under the following
terms:

All of the documentation and software included in the ELWIX and AITNET
Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>

Copyright 2004 - 2026
	by Michael Pounov <misho@elwix.org>.  All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software
   must display the following acknowledgement:
This product includes software developed by Michael Pounov <misho@elwix.org>
ELWIX - Embedded LightWeight unIX and its contributors.
4. Neither the name of AITNET nor the names of its contributors
   may be used to endorse or promote products derived from this software
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
*/
#ifndef __ARING_H
#define __ARING_H

#define E_ATOMIC_ALIGN	alignas(sizeof(int) * 8)

typedef struct {
	E_ATOMIC_ALIGN	int		rb_head;
	E_ATOMIC_ALIGN	int		rb_tail;
			int		rb_bufnum;
			struct iovec	*rb_buffer;
} ringbuf_t;

typedef struct {
	E_ATOMIC_ALIGN	unsigned int	lrb_head;
	E_ATOMIC_ALIGN	unsigned int	lrb_tail;
	E_ATOMIC_ALIGN	unsigned int	lrb_full;
			int		lrb_size;
			unsigned char	*lrb_data;
} lrbuf_t;
#define lrb_queued(x, r)	do { \
					u_int _h, _t; \
					_t = atomic_load_explicit((atomic_int*) &(x)->lrb_tail, memory_order_acquire); \
					_h = atomic_load_explicit((atomic_int*) &(x)->lrb_head, memory_order_relaxed); \
					if (_h == _t) \
						(r) = atomic_load_explicit((atomic_int*) &(x)->lrb_full, memory_order_acquire) ? \
							(x)->lrb_size : 0; \
					else \
						(r) = (_h + (x)->lrb_size - _t) % (x)->lrb_size; \
				} while (0)
#define lrb_unused(x, r)	do { \
					u_int _r; \
					lrb_queued((x), _r); \
					(r) = (x)->lrb_size - _r; \
				} while (0)


/*
 * rbuf_init() - Init ring buffer
 *
 * @rbuf = Ring buffer
 * @num = Number of elements in buffer
 * return: -1 error or 0 ok
 */
int rbuf_init(ringbuf_t *rbuf, int num);
/*
 * rbuf_free() - Free ring buffer
 *
 * @rbuf = Ring buffer
 * return: none
 */
void rbuf_free(ringbuf_t *rbuf);
/*
 * rbuf_purge() - Purge all buffer
 *
 * @rbuf = Ring buffer
 * return: none
 */
void rbuf_purge(ringbuf_t *rbuf);
/*
 * rbuf_isempty() - Check buffer is empty
 *
 * @rbuf = Ring buffer
 * return: -1 error, 0 it isn't empty
 */
int rbuf_isempty(ringbuf_t *rbuf);
/*
 * rbuf_isfull() - Check buffer is full
 *
 * @rbuf = Ring buffer
 * return: -1 error or 0 it isn't full
 */
int rbuf_isfull(ringbuf_t *rbuf);

/*
 * rbuf_enqueue() - Enqueue data to buffer
 *
 * @rbuf = Ring buffer
 * @data = Data
 * @len = Length
 * return: -1 error, 1 can't add data, buffer is full or 0 ok
 */
int rbuf_enqueue(ringbuf_t *rbuf, void *data, size_t len);
/*
 * rbuf_dequeue() - Dequeue data from buffer
 *
 * @rbuf = Ring buffer
 * @out = Data, if =NULL, just dequeue data
 * return: -1 error, 1 buffer is empty or 0 ok
 */
int rbuf_dequeue(ringbuf_t *rbuf, struct iovec **out);


/*
 * lrb_init() - Init linear ring buffer
 *
 * @lrb = Linear ring buffer
 * @size = Size of ring buffer
 * return: -1 error or 0 ok
 */
int lrb_init(lrbuf_t *lrb, u_int size);
/*
 * lrb_free() - Free linear ring buffer
 *
 * @lrb = Linear ring buffer
 * return: none
 */
void lrb_free(lrbuf_t *lrb);
/*
 * lrb_purge() - Purge all buffer
 *
 * @lrb = Linear ring buffer
 * return: none
 */
void lrb_purge(lrbuf_t *lrb);
/*
 * lrb_isempty() - Check buffer is empty
 *
 * @lrb = Linear ring buffer
 * return: -1 error, 0 it isn't empty
 */
int lrb_isempty(lrbuf_t *lrb);
/*
 * lrb_isfull() - Check buffer is full
 *
 * @lrb = Linear ring buffer
 * return: -1 error or 0 it isn't full
 */
int lrb_isfull(lrbuf_t *lrb);
/*
 * lrb_enqueue() - Enqueue data to buffer
 *
 * @lrb = Linear ring buffer
 * @data = Data
 * @len = Length
 * @lost = Permit to lost data
 * return: -1 error, 1 buffer is full or 0 ok
 */
int lrb_enqueue(lrbuf_t *lrb, void *data, size_t len, int lost);
/*
 * lrb_dequeue() - Dequeue data from buffer
 *
 * @lrb = Linear ring buffer
 * @data = Data, if =NULL, just dequeue data
 * @len = Length of data
 * return: -1 error, 0 buffer is empty or >0 stored data bytes
 */
int lrb_dequeue(lrbuf_t *lrb, void *data, size_t len);
/*
 * lrb_getw() - Get address for write
 *
 * @lrb = Linear ring buffer
 * @len = Return available buffer length for write
 * return: NULL error or !=NULL pointer for write
 * remark: After use of lrb_getw() and write to pointer.
 * 		You should update ring buffer with lrb_enqueue(,NULL,wrote_len,)
 */
void *lrb_getw(lrbuf_t *lrb, size_t *len);
/*
 * lrb_getr() - Get address for read
 *
 * @lrb = Linear ring buffer
 * @len = Return available data length for read
 * return: NULL error or !=NULL pointer for read
 * remark: After use of lrb_getr() and read from pointer.
 * 		You could update ring buffer with lrb_dequeue(,NULL,read_len)
 */
void *lrb_getr(lrbuf_t *lrb, size_t *len);


#endif