lib/librte_cmdline/cmdline_cirbuf.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34
  35 /*
  36  * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
  37  * All rights reserved.
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions are met:
  40  *
  41  *     * Redistributions of source code must retain the above copyright
  42  *       notice, this list of conditions and the following disclaimer.
  43  *     * Redistributions in binary form must reproduce the above copyright
  44  *       notice, this list of conditions and the following disclaimer in the
  45  *       documentation and/or other materials provided with the distribution.
  46  *     * Neither the name of the University of California, Berkeley nor the
  47  *       names of its contributors may be used to endorse or promote products
  48  *       derived from this software without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  51  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  52  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  53  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  54  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  55  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  56  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  57  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  58  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  59  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  60  */
  61
  62 #ifndef _CIRBUF_H_
  63 #define _CIRBUF_H_
  64
  65 #ifdef __cplusplus
  66 extern "C" {
  67 #endif
  68
  69 /**
  70  * This structure is the header of a cirbuf type.
  71  */
  72 struct cirbuf {
  73         unsigned int maxlen;    /**< total len of the fifo (number of elements) */
  74         unsigned int start;     /**< indice of the first elt */
  75         unsigned int end;       /**< indice of the last elt */
  76         unsigned int len;       /**< current len of fifo */
  77         char *buf;
  78 };
  79
  80 /* #define CIRBUF_DEBUG */
  81
  82 #ifdef CIRBUF_DEBUG
  83 #define dprintf(fmt, ...) printf("line %3.3d - " fmt, __LINE__, ##__VA_ARGS__)
  84 #else
  85 #define dprintf(args...) do {} while(0)
  86 #endif
  87
  88
  89 /**
  90  * Init the circular buffer
  91  */
  92 void cirbuf_init(struct cirbuf *cbuf, char *buf, unsigned int start, unsigned int maxlen);
  93
  94
  95 /**
  96  * Return 1 if the circular buffer is full
  97  */
  98 #define CIRBUF_IS_FULL(cirbuf) ((cirbuf)->maxlen == (cirbuf)->len)
  99
 100 /**
 101  * Return 1 if the circular buffer is empty
 102  */
 103 #define CIRBUF_IS_EMPTY(cirbuf) ((cirbuf)->len == 0)
 104
 105 /**
 106  * return current size of the circular buffer (number of used elements)
 107  */
 108 #define CIRBUF_GET_LEN(cirbuf) ((cirbuf)->len)
 109
 110 /**
 111  * return size of the circular buffer (used + free elements)
 112  */
 113 #define CIRBUF_GET_MAXLEN(cirbuf) ((cirbuf)->maxlen)
 114
 115 /**
 116  * return the number of free elts
 117  */
 118 #define CIRBUF_GET_FREELEN(cirbuf) ((cirbuf)->maxlen - (cirbuf)->len)
 119
 120 /**
 121  * Iterator for a circular buffer
 122  *   c: struct cirbuf pointer
 123  *   i: an integer type internally used in the macro
 124  *   e: char that takes the value for each iteration
 125  */
 126 #define CIRBUF_FOREACH(c, i, e)                                 \
 127         for ( i=0, e=(c)->buf[(c)->start] ;                     \
 128                 i<((c)->len) ;                                  \
 129                 i ++,  e=(c)->buf[((c)->start+i)%((c)->maxlen)])
 130
 131
 132 /**
 133  * Add a character at head of the circular buffer. Return 0 on success, or
 134  * a negative value on error.
 135  */
 136 int cirbuf_add_head_safe(struct cirbuf *cbuf, char c);
 137
 138 /**
 139  * Add a character at head of the circular buffer. You _must_ check that you
 140  * have enough free space in the buffer before calling this func.
 141  */
 142 void cirbuf_add_head(struct cirbuf *cbuf, char c);
 143
 144 /**
 145  * Add a character at tail of the circular buffer. Return 0 on success, or
 146  * a negative value on error.
 147  */
 148 int cirbuf_add_tail_safe(struct cirbuf *cbuf, char c);
 149
 150 /**
 151  * Add a character at tail of the circular buffer. You _must_ check that you
 152  * have enough free space in the buffer before calling this func.
 153  */
 154 void cirbuf_add_tail(struct cirbuf *cbuf, char c);
 155
 156 /**
 157  * Remove a char at the head of the circular buffer. Return 0 on
 158  * success, or a negative value on error.
 159  */
 160 int cirbuf_del_head_safe(struct cirbuf *cbuf);
 161
 162 /**
 163  * Remove a char at the head of the circular buffer. You _must_ check
 164  * that buffer is not empty before calling the function.
 165  */
 166 void cirbuf_del_head(struct cirbuf *cbuf);
 167
 168 /**
 169  * Remove a char at the tail of the circular buffer. Return 0 on
 170  * success, or a negative value on error.
 171  */
 172 int cirbuf_del_tail_safe(struct cirbuf *cbuf);
 173
 174 /**
 175  * Remove a char at the tail of the circular buffer. You _must_ check
 176  * that buffer is not empty before calling the function.
 177  */
 178 void cirbuf_del_tail(struct cirbuf *cbuf);
 179
 180 /**
 181  * Return the head of the circular buffer. You _must_ check that
 182  * buffer is not empty before calling the function.
 183  */
 184 char cirbuf_get_head(struct cirbuf *cbuf);
 185
 186 /**
 187  * Return the tail of the circular buffer. You _must_ check that
 188  * buffer is not empty before calling the function.
 189  */
 190 char cirbuf_get_tail(struct cirbuf *cbuf);
 191
 192 /**
 193  * Add a buffer at head of the circular buffer. 'c' is a pointer to a
 194  * buffer, and n is the number of char to add. Return the number of
 195  * copied bytes on success, or a negative value on error.
 196  */
 197 int cirbuf_add_buf_head(struct cirbuf *cbuf, const char *c, unsigned int n);
 198
 199 /**
 200  * Add a buffer at tail of the circular buffer. 'c' is a pointer to a
 201  * buffer, and n is the number of char to add. Return the number of
 202  * copied bytes on success, or a negative value on error.
 203  */
 204 int cirbuf_add_buf_tail(struct cirbuf *cbuf, const char *c, unsigned int n);
 205
 206 /**
 207  * Remove chars at the head of the circular buffer. Return 0 on
 208  * success, or a negative value on error.
 209  */
 210 int cirbuf_del_buf_head(struct cirbuf *cbuf, unsigned int size);
 211
 212 /**
 213  * Remove chars at the tail of the circular buffer. Return 0 on
 214  * success, or a negative value on error.
 215  */
 216 int cirbuf_del_buf_tail(struct cirbuf *cbuf, unsigned int size);
 217
 218 /**
 219  * Copy a maximum of 'size' characters from the head of the circular
 220  * buffer to a flat one pointed by 'c'. Return the number of copied
 221  * chars.
 222  */
 223 int cirbuf_get_buf_head(struct cirbuf *cbuf, char *c, unsigned int size);
 224
 225 /**
 226  * Copy a maximum of 'size' characters from the tail of the circular
 227  * buffer to a flat one pointed by 'c'. Return the number of copied
 228  * chars.
 229  */
 230 int cirbuf_get_buf_tail(struct cirbuf *cbuf, char *c, unsigned int size);
 231
 232
 233 /**
 234  * Set the start of the data to the index 0 of the internal buffer.
 235  */
 236 void cirbuf_align_left(struct cirbuf *cbuf);
 237
 238 /**
 239  * Set the end of the data to the last index of the internal buffer.
 240  */
 241 void cirbuf_align_right(struct cirbuf *cbuf);
 242
 243 #ifdef __cplusplus
 244 }
 245 #endif
 246
 247 #endif /* _CIRBUF_H_ */