1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 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 #include <string.h>
35 #include <stdio.h>
36 
37 #include <rte_common.h>
38 #include <rte_mbuf.h>
39 #include <rte_memory.h>
40 #include <rte_malloc.h>
41 #include <rte_log.h>
42 
43 #include "rte_table_array.h"
44 
45 #ifdef RTE_TABLE_STATS_COLLECT
46 
47 #define RTE_TABLE_ARRAY_STATS_PKTS_IN_ADD(table, val) \
48 	table->stats.n_pkts_in += val
49 #define RTE_TABLE_ARRAY_STATS_PKTS_LOOKUP_MISS(table, val) \
50 	table->stats.n_pkts_lookup_miss += val
51 
52 #else
53 
54 #define RTE_TABLE_ARRAY_STATS_PKTS_IN_ADD(table, val)
55 #define RTE_TABLE_ARRAY_STATS_PKTS_LOOKUP_MISS(table, val)
56 
57 #endif
58 
59 struct rte_table_array {
60 	struct rte_table_stats stats;
61 
62 	/* Input parameters */
63 	uint32_t entry_size;
64 	uint32_t n_entries;
65 	uint32_t offset;
66 
67 	/* Internal fields */
68 	uint32_t entry_pos_mask;
69 
70 	/* Internal table */
71 	uint8_t array[0] __rte_cache_aligned;
72 } __rte_cache_aligned;
73 
74 static void *
75 rte_table_array_create(void *params, int socket_id, uint32_t entry_size)
76 {
77 	struct rte_table_array_params *p =
78 		(struct rte_table_array_params *) params;
79 	struct rte_table_array *t;
80 	uint32_t total_cl_size, total_size;
81 
82 	/* Check input parameters */
83 	if ((p == NULL) ||
84 	    (p->n_entries == 0) ||
85 		(!rte_is_power_of_2(p->n_entries)))
86 		return NULL;
87 
88 	/* Memory allocation */
89 	total_cl_size = (sizeof(struct rte_table_array) +
90 			RTE_CACHE_LINE_SIZE) / RTE_CACHE_LINE_SIZE;
91 	total_cl_size += (p->n_entries * entry_size +
92 			RTE_CACHE_LINE_SIZE) / RTE_CACHE_LINE_SIZE;
93 	total_size = total_cl_size * RTE_CACHE_LINE_SIZE;
94 	t = rte_zmalloc_socket("TABLE", total_size, RTE_CACHE_LINE_SIZE, socket_id);
95 	if (t == NULL) {
96 		RTE_LOG(ERR, TABLE,
97 			"%s: Cannot allocate %u bytes for array table\n",
98 			__func__, total_size);
99 		return NULL;
100 	}
101 
102 	/* Memory initialization */
103 	t->entry_size = entry_size;
104 	t->n_entries = p->n_entries;
105 	t->offset = p->offset;
106 	t->entry_pos_mask = t->n_entries - 1;
107 
108 	return t;
109 }
110 
111 static int
112 rte_table_array_free(void *table)
113 {
114 	struct rte_table_array *t = (struct rte_table_array *) table;
115 
116 	/* Check input parameters */
117 	if (t == NULL) {
118 		RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
119 		return -EINVAL;
120 	}
121 
122 	/* Free previously allocated resources */
123 	rte_free(t);
124 
125 	return 0;
126 }
127 
128 static int
129 rte_table_array_entry_add(
130 	void *table,
131 	void *key,
132 	void *entry,
133 	int *key_found,
134 	void **entry_ptr)
135 {
136 	struct rte_table_array *t = (struct rte_table_array *) table;
137 	struct rte_table_array_key *k = (struct rte_table_array_key *) key;
138 	uint8_t *table_entry;
139 
140 	/* Check input parameters */
141 	if (table == NULL) {
142 		RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
143 		return -EINVAL;
144 	}
145 	if (key == NULL) {
146 		RTE_LOG(ERR, TABLE, "%s: key parameter is NULL\n", __func__);
147 		return -EINVAL;
148 	}
149 	if (entry == NULL) {
150 		RTE_LOG(ERR, TABLE, "%s: entry parameter is NULL\n", __func__);
151 		return -EINVAL;
152 	}
153 	if (key_found == NULL) {
154 		RTE_LOG(ERR, TABLE, "%s: key_found parameter is NULL\n",
155 			__func__);
156 		return -EINVAL;
157 	}
158 	if (entry_ptr == NULL) {
159 		RTE_LOG(ERR, TABLE, "%s: entry_ptr parameter is NULL\n",
160 			__func__);
161 		return -EINVAL;
162 	}
163 
164 	table_entry = &t->array[k->pos * t->entry_size];
165 	memcpy(table_entry, entry, t->entry_size);
166 	*key_found = 1;
167 	*entry_ptr = (void *) table_entry;
168 
169 	return 0;
170 }
171 
172 static int
173 rte_table_array_lookup(
174 	void *table,
175 	struct rte_mbuf **pkts,
176 	uint64_t pkts_mask,
177 	uint64_t *lookup_hit_mask,
178 	void **entries)
179 {
180 	struct rte_table_array *t = (struct rte_table_array *) table;
181 	__rte_unused uint32_t n_pkts_in = __builtin_popcountll(pkts_mask);
182 	RTE_TABLE_ARRAY_STATS_PKTS_IN_ADD(t, n_pkts_in);
183 	*lookup_hit_mask = pkts_mask;
184 
185 	if ((pkts_mask & (pkts_mask + 1)) == 0) {
186 		uint64_t n_pkts = __builtin_popcountll(pkts_mask);
187 		uint32_t i;
188 
189 		for (i = 0; i < n_pkts; i++) {
190 			struct rte_mbuf *pkt = pkts[i];
191 			uint32_t entry_pos = RTE_MBUF_METADATA_UINT32(pkt,
192 				t->offset) & t->entry_pos_mask;
193 
194 			entries[i] = (void *) &t->array[entry_pos *
195 				t->entry_size];
196 		}
197 	} else {
198 		for ( ; pkts_mask; ) {
199 			uint32_t pkt_index = __builtin_ctzll(pkts_mask);
200 			uint64_t pkt_mask = 1LLU << pkt_index;
201 			struct rte_mbuf *pkt = pkts[pkt_index];
202 			uint32_t entry_pos = RTE_MBUF_METADATA_UINT32(pkt,
203 				t->offset) & t->entry_pos_mask;
204 
205 			entries[pkt_index] = (void *) &t->array[entry_pos *
206 				t->entry_size];
207 			pkts_mask &= ~pkt_mask;
208 		}
209 	}
210 
211 	return 0;
212 }
213 
214 static int
215 rte_table_array_stats_read(void *table, struct rte_table_stats *stats, int clear)
216 {
217 	struct rte_table_array *array = (struct rte_table_array *) table;
218 
219 	if (stats != NULL)
220 		memcpy(stats, &array->stats, sizeof(array->stats));
221 
222 	if (clear)
223 		memset(&array->stats, 0, sizeof(array->stats));
224 
225 	return 0;
226 }
227 
228 struct rte_table_ops rte_table_array_ops = {
229 	.f_create = rte_table_array_create,
230 	.f_free = rte_table_array_free,
231 	.f_add = rte_table_array_entry_add,
232 	.f_delete = NULL,
233 	.f_add_bulk = NULL,
234 	.f_delete_bulk = NULL,
235 	.f_lookup = rte_table_array_lookup,
236 	.f_stats = rte_table_array_stats_read,
237 };
238