78232cc2e2c3e9c1f05662d931cb4e43cfbfdb2b
[dpdk.git] / lib / librte_kni / rte_kni_fifo.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
37 /**
38  * Initializes the kni fifo structure
39  */
40 static void
41 kni_fifo_init(struct rte_kni_fifo *fifo, unsigned size)
42 {
43         /* Ensure size is power of 2 */
44         if (size & (size - 1))
45                 rte_panic("KNI fifo size must be power of 2\n");
46
47         fifo->write = 0;
48         fifo->read = 0;
49         fifo->len = size;
50         fifo->elem_size = sizeof(void *);
51 }
52
53 /**
54  * Adds num elements into the fifo. Return the number actually written
55  */
56 static inline unsigned
57 kni_fifo_put(struct rte_kni_fifo *fifo, void **data, unsigned num)
58 {
59         unsigned i = 0;
60         unsigned fifo_write = fifo->write;
61         unsigned fifo_read = fifo->read;
62         unsigned new_write = fifo_write;
63
64         for (i = 0; i < num; i++) {
65                 new_write = (new_write + 1) & (fifo->len - 1);
66
67                 if (new_write == fifo_read)
68                         break;
69                 fifo->buffer[fifo_write] = data[i];
70                 fifo_write = new_write;
71         }
72         fifo->write = fifo_write;
73         return i;
74 }
75
76 /**
77  * Get up to num elements from the fifo. Return the number actully read
78  */
79 static inline unsigned
80 kni_fifo_get(struct rte_kni_fifo *fifo, void **data, unsigned num)
81 {
82         unsigned i = 0;
83         unsigned new_read = fifo->read;
84         unsigned fifo_write = fifo->write;
85         for (i = 0; i < num; i++) {
86                 if (new_read == fifo_write)
87                         break;
88
89                 data[i] = fifo->buffer[new_read];
90                 new_read = (new_read + 1) & (fifo->len - 1);
91         }
92         fifo->read = new_read;
93         return i;
94 }