Return to aring.h CVS log

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

Version 6.11

    1: /*************************************************************************
    2: * (C) 2025 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
    3: *  by Michael Pounov <misho@elwix.org>
    4: *
    5: * $Author: misho $
    6: * $Id: aring.h,v 1.4 2025/09/30 11:38:28 misho Exp $
    7: *
    8: **************************************************************************
    9: The ELWIX and AITNET software is distributed under the following
   10: terms:
   11: 
   12: All of the documentation and software included in the ELWIX and AITNET
   13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
   14: 
   15: Copyright 2004 - 2025
   16: 	by Michael Pounov <misho@elwix.org>.  All rights reserved.
   17: 
   18: Redistribution and use in source and binary forms, with or without
   19: modification, are permitted provided that the following conditions
   20: are met:
   21: 1. Redistributions of source code must retain the above copyright
   22:    notice, this list of conditions and the following disclaimer.
   23: 2. Redistributions in binary form must reproduce the above copyright
   24:    notice, this list of conditions and the following disclaimer in the
   25:    documentation and/or other materials provided with the distribution.
   26: 3. All advertising materials mentioning features or use of this software
   27:    must display the following acknowledgement:
   28: This product includes software developed by Michael Pounov <misho@elwix.org>
   29: ELWIX - Embedded LightWeight unIX and its contributors.
   30: 4. Neither the name of AITNET nor the names of its contributors
   31:    may be used to endorse or promote products derived from this software
   32:    without specific prior written permission.
   33: 
   34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
   35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   37: ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   44: SUCH DAMAGE.
   45: */
   46: #ifndef __ARING_H
   47: #define __ARING_H
   48: 
   49: #define E_ATOMIC_ALIGN	alignas(sizeof(int) * 8)
   50: 
   51: typedef struct {
   52: 	E_ATOMIC_ALIGN	int		rb_head;
   53: 	E_ATOMIC_ALIGN	int		rb_tail;
   54: 			int		rb_bufnum;
   55: 			struct iovec	*rb_buffer;
   56: } ringbuf_t;
   57: 
   58: 
   59: /*
   60:  * rbuf_init() - Init ring buffer
   61:  *
   62:  * @rbuf = Ring buffer
   63:  * @num = Number of elements in buffer
   64:  * return: -1 error or 0 ok
   65:  */
   66: int rbuf_init(ringbuf_t *rbuf, int num);
   67: /*
   68:  * rbuf_free() - Free ring buffer
   69:  *
   70:  * @rbuf = Ring buffer
   71:  * return: none
   72:  */
   73: void rbuf_free(ringbuf_t *rbuf);
   74: /*
   75:  * rbuf_purge() - Purge all buffer
   76:  *
   77:  * @rbuf = Ring buffer
   78:  * return: none
   79:  */
   80: void rbuf_purge(ringbuf_t *rbuf);
   81: /*
   82:  * rbuf_isempty() - Check buffer is empty
   83:  *
   84:  * @rbuf = Ring buffer
   85:  * return: -1 error, 0 it isn't empty
   86:  */
   87: int rbuf_isempty(ringbuf_t *rbuf);
   88: /*
   89:  * rbuf_isfull() - Check buffer is full
   90:  *
   91:  * @rbuf = Ring buffer
   92:  * return: -1 error or 0 it isn't full
   93:  */
   94: int rbuf_isfull(ringbuf_t *rbuf);
   95: 
   96: /*
   97:  * rbuf_enqueue() - Enqueue data to buffer
   98:  *
   99:  * @rbuf = Ring buffer
  100:  * @data = Data
  101:  * @len = Length
  102:  * return: -1 error, 1 can't add data, buffer is full or 0 ok
  103:  */
  104: int rbuf_enqueue(ringbuf_t *rbuf, void *data, size_t len);
  105: /*
  106:  * rbuf_dequeue() - Dequeue data from buffer
  107:  *
  108:  * @rbuf = Ring buffer
  109:  * @out = Data, if =NULL, just dequeue data
  110:  * return: -1 error, 1 buffer is empty or 0 ok
  111:  */
  112: int rbuf_dequeue(ringbuf_t *rbuf, struct iovec **out);
  113: 
  114: 
  115: #endif