4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
35 * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
36 * All rights reserved.
37 * Redistribution and use in source and binary forms, with or without
38 * modification, are permitted provided that the following conditions are met:
40 * * Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * * Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in the
44 * documentation and/or other materials provided with the distribution.
45 * * Neither the name of the University of California, Berkeley nor the
46 * names of its contributors may be used to endorse or promote products
47 * derived from this software without specific prior written permission.
49 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
50 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
51 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
52 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
53 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
54 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
55 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
56 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
57 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
58 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
64 #include <rte_config.h>
71 * This structure is the header of a cirbuf type.
74 unsigned int maxlen; /**< total len of the fifo (number of elements) */
75 unsigned int start; /**< indice of the first elt */
76 unsigned int end; /**< indice of the last elt */
77 unsigned int len; /**< current len of fifo */
81 #ifdef RTE_LIBRTE_CMDLINE_DEBUG
82 #define dprintf_(fmt, ...) printf("line %3.3d - " fmt "%.0s", __LINE__, __VA_ARGS__)
83 #define dprintf(...) dprintf_(__VA_ARGS__, "dummy")
85 #define dprintf(...) (void)0
90 * Init the circular buffer
92 int cirbuf_init(struct cirbuf *cbuf, char *buf, unsigned int start, unsigned int maxlen);
96 * Return 1 if the circular buffer is full
98 #define CIRBUF_IS_FULL(cirbuf) ((cirbuf)->maxlen == (cirbuf)->len)
101 * Return 1 if the circular buffer is empty
103 #define CIRBUF_IS_EMPTY(cirbuf) ((cirbuf)->len == 0)
106 * return current size of the circular buffer (number of used elements)
108 #define CIRBUF_GET_LEN(cirbuf) ((cirbuf)->len)
111 * return size of the circular buffer (used + free elements)
113 #define CIRBUF_GET_MAXLEN(cirbuf) ((cirbuf)->maxlen)
116 * return the number of free elts
118 #define CIRBUF_GET_FREELEN(cirbuf) ((cirbuf)->maxlen - (cirbuf)->len)
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
126 #define CIRBUF_FOREACH(c, i, e) \
127 for ( i=0, e=(c)->buf[(c)->start] ; \
129 i ++, e=(c)->buf[((c)->start+i)%((c)->maxlen)])
133 * Add a character at head of the circular buffer. Return 0 on success, or
134 * a negative value on error.
136 int cirbuf_add_head_safe(struct cirbuf *cbuf, char c);
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.
142 void cirbuf_add_head(struct cirbuf *cbuf, char c);
145 * Add a character at tail of the circular buffer. Return 0 on success, or
146 * a negative value on error.
148 int cirbuf_add_tail_safe(struct cirbuf *cbuf, char c);
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.
154 void cirbuf_add_tail(struct cirbuf *cbuf, char c);
157 * Remove a char at the head of the circular buffer. Return 0 on
158 * success, or a negative value on error.
160 int cirbuf_del_head_safe(struct cirbuf *cbuf);
163 * Remove a char at the head of the circular buffer. You _must_ check
164 * that buffer is not empty before calling the function.
166 void cirbuf_del_head(struct cirbuf *cbuf);
169 * Remove a char at the tail of the circular buffer. Return 0 on
170 * success, or a negative value on error.
172 int cirbuf_del_tail_safe(struct cirbuf *cbuf);
175 * Remove a char at the tail of the circular buffer. You _must_ check
176 * that buffer is not empty before calling the function.
178 void cirbuf_del_tail(struct cirbuf *cbuf);
181 * Return the head of the circular buffer. You _must_ check that
182 * buffer is not empty before calling the function.
184 char cirbuf_get_head(struct cirbuf *cbuf);
187 * Return the tail of the circular buffer. You _must_ check that
188 * buffer is not empty before calling the function.
190 char cirbuf_get_tail(struct cirbuf *cbuf);
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.
197 int cirbuf_add_buf_head(struct cirbuf *cbuf, const char *c, unsigned int n);
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.
204 int cirbuf_add_buf_tail(struct cirbuf *cbuf, const char *c, unsigned int n);
207 * Remove chars at the head of the circular buffer. Return 0 on
208 * success, or a negative value on error.
210 int cirbuf_del_buf_head(struct cirbuf *cbuf, unsigned int size);
213 * Remove chars at the tail of the circular buffer. Return 0 on
214 * success, or a negative value on error.
216 int cirbuf_del_buf_tail(struct cirbuf *cbuf, unsigned int size);
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
223 int cirbuf_get_buf_head(struct cirbuf *cbuf, char *c, unsigned int size);
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
230 int cirbuf_get_buf_tail(struct cirbuf *cbuf, char *c, unsigned int size);
234 * Set the start of the data to the index 0 of the internal buffer.
236 int cirbuf_align_left(struct cirbuf *cbuf);
239 * Set the end of the data to the last index of the internal buffer.
241 int cirbuf_align_right(struct cirbuf *cbuf);
247 #endif /* _CIRBUF_H_ */