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.
37 #include <rte_common.h>
39 #include <rte_memory.h>
40 #include <rte_malloc.h>
43 #include "rte_table_hash.h"
45 #define KEYS_PER_BUCKET 4
52 uint16_t sig[KEYS_PER_BUCKET];
53 uint32_t key_pos[KEYS_PER_BUCKET];
56 #define BUCKET_NEXT(bucket) \
57 ((void *) ((bucket)->next & (~1LU)))
59 #define BUCKET_NEXT_VALID(bucket) \
60 ((bucket)->next & 1LU)
62 #define BUCKET_NEXT_SET(bucket, bucket_next) \
64 (bucket)->next = (((uintptr_t) ((void *) (bucket_next))) | 1LU);\
67 #define BUCKET_NEXT_SET_NULL(bucket) \
72 #define BUCKET_NEXT_COPY(bucket, bucket2) \
74 (bucket)->next = (bucket2)->next; \
77 #ifdef RTE_TABLE_STATS_COLLECT
79 #define RTE_TABLE_HASH_EXT_STATS_PKTS_IN_ADD(table, val) \
80 table->stats.n_pkts_in += val
81 #define RTE_TABLE_HASH_EXT_STATS_PKTS_LOOKUP_MISS(table, val) \
82 table->stats.n_pkts_lookup_miss += val
86 #define RTE_TABLE_HASH_EXT_STATS_PKTS_IN_ADD(table, val)
87 #define RTE_TABLE_HASH_EXT_STATS_PKTS_LOOKUP_MISS(table, val)
98 struct rte_table_hash {
99 struct rte_table_stats stats;
101 /* Input parameters */
106 uint32_t n_buckets_ext;
107 rte_table_hash_op_hash f_hash;
109 uint32_t signature_offset;
113 uint64_t bucket_mask;
114 uint32_t key_size_shl;
115 uint32_t data_size_shl;
116 uint32_t key_stack_tos;
117 uint32_t bkt_ext_stack_tos;
120 struct grinder grinders[RTE_PORT_IN_BURST_SIZE_MAX];
123 struct bucket *buckets;
124 struct bucket *buckets_ext;
128 uint32_t *bkt_ext_stack;
131 uint8_t memory[0] __rte_cache_aligned;
135 check_params_create(struct rte_table_hash_ext_params *params)
137 uint32_t n_buckets_min;
140 if ((params->key_size == 0) ||
141 (!rte_is_power_of_2(params->key_size))) {
142 RTE_LOG(ERR, TABLE, "%s: key_size invalid value\n", __func__);
147 if ((params->n_keys == 0) ||
148 (!rte_is_power_of_2(params->n_keys))) {
149 RTE_LOG(ERR, TABLE, "%s: n_keys invalid value\n", __func__);
154 n_buckets_min = (params->n_keys + KEYS_PER_BUCKET - 1) / params->n_keys;
155 if ((params->n_buckets == 0) ||
156 (!rte_is_power_of_2(params->n_keys)) ||
157 (params->n_buckets < n_buckets_min)) {
158 RTE_LOG(ERR, TABLE, "%s: n_buckets invalid value\n", __func__);
163 if (params->f_hash == NULL) {
164 RTE_LOG(ERR, TABLE, "%s: f_hash invalid value\n", __func__);
172 rte_table_hash_ext_create(void *params, int socket_id, uint32_t entry_size)
174 struct rte_table_hash_ext_params *p =
175 (struct rte_table_hash_ext_params *) params;
176 struct rte_table_hash *t;
177 uint32_t total_size, table_meta_sz;
178 uint32_t bucket_sz, bucket_ext_sz, key_sz;
179 uint32_t key_stack_sz, bkt_ext_stack_sz, data_sz;
180 uint32_t bucket_offset, bucket_ext_offset, key_offset;
181 uint32_t key_stack_offset, bkt_ext_stack_offset, data_offset;
184 /* Check input parameters */
185 if ((check_params_create(p) != 0) ||
186 (!rte_is_power_of_2(entry_size)) ||
187 ((sizeof(struct rte_table_hash) % RTE_CACHE_LINE_SIZE) != 0) ||
188 (sizeof(struct bucket) != (RTE_CACHE_LINE_SIZE / 2)))
191 /* Memory allocation */
192 table_meta_sz = RTE_CACHE_LINE_ROUNDUP(sizeof(struct rte_table_hash));
193 bucket_sz = RTE_CACHE_LINE_ROUNDUP(p->n_buckets * sizeof(struct bucket));
195 RTE_CACHE_LINE_ROUNDUP(p->n_buckets_ext * sizeof(struct bucket));
196 key_sz = RTE_CACHE_LINE_ROUNDUP(p->n_keys * p->key_size);
197 key_stack_sz = RTE_CACHE_LINE_ROUNDUP(p->n_keys * sizeof(uint32_t));
199 RTE_CACHE_LINE_ROUNDUP(p->n_buckets_ext * sizeof(uint32_t));
200 data_sz = RTE_CACHE_LINE_ROUNDUP(p->n_keys * entry_size);
201 total_size = table_meta_sz + bucket_sz + bucket_ext_sz + key_sz +
202 key_stack_sz + bkt_ext_stack_sz + data_sz;
204 t = rte_zmalloc_socket("TABLE", total_size, RTE_CACHE_LINE_SIZE, socket_id);
207 "%s: Cannot allocate %u bytes for hash table\n",
208 __func__, total_size);
211 RTE_LOG(INFO, TABLE, "%s (%u-byte key): Hash table memory footprint is "
212 "%u bytes\n", __func__, p->key_size, total_size);
214 /* Memory initialization */
215 t->key_size = p->key_size;
216 t->entry_size = entry_size;
217 t->n_keys = p->n_keys;
218 t->n_buckets = p->n_buckets;
219 t->n_buckets_ext = p->n_buckets_ext;
220 t->f_hash = p->f_hash;
222 t->signature_offset = p->signature_offset;
223 t->key_offset = p->key_offset;
226 t->bucket_mask = t->n_buckets - 1;
227 t->key_size_shl = __builtin_ctzl(p->key_size);
228 t->data_size_shl = __builtin_ctzl(entry_size);
232 bucket_ext_offset = bucket_offset + bucket_sz;
233 key_offset = bucket_ext_offset + bucket_ext_sz;
234 key_stack_offset = key_offset + key_sz;
235 bkt_ext_stack_offset = key_stack_offset + key_stack_sz;
236 data_offset = bkt_ext_stack_offset + bkt_ext_stack_sz;
238 t->buckets = (struct bucket *) &t->memory[bucket_offset];
239 t->buckets_ext = (struct bucket *) &t->memory[bucket_ext_offset];
240 t->key_mem = &t->memory[key_offset];
241 t->key_stack = (uint32_t *) &t->memory[key_stack_offset];
242 t->bkt_ext_stack = (uint32_t *) &t->memory[bkt_ext_stack_offset];
243 t->data_mem = &t->memory[data_offset];
246 for (i = 0; i < t->n_keys; i++)
247 t->key_stack[i] = t->n_keys - 1 - i;
248 t->key_stack_tos = t->n_keys;
250 /* Bucket ext stack */
251 for (i = 0; i < t->n_buckets_ext; i++)
252 t->bkt_ext_stack[i] = t->n_buckets_ext - 1 - i;
253 t->bkt_ext_stack_tos = t->n_buckets_ext;
259 rte_table_hash_ext_free(void *table)
261 struct rte_table_hash *t = (struct rte_table_hash *) table;
263 /* Check input parameters */
272 rte_table_hash_ext_entry_add(void *table, void *key, void *entry,
273 int *key_found, void **entry_ptr)
275 struct rte_table_hash *t = (struct rte_table_hash *) table;
276 struct bucket *bkt0, *bkt, *bkt_prev;
278 uint32_t bkt_index, i;
280 sig = t->f_hash(key, t->key_size, t->seed);
281 bkt_index = sig & t->bucket_mask;
282 bkt0 = &t->buckets[bkt_index];
283 sig = (sig >> 16) | 1LLU;
285 /* Key is present in the bucket */
286 for (bkt = bkt0; bkt != NULL; bkt = BUCKET_NEXT(bkt))
287 for (i = 0; i < KEYS_PER_BUCKET; i++) {
288 uint64_t bkt_sig = (uint64_t) bkt->sig[i];
289 uint32_t bkt_key_index = bkt->key_pos[i];
291 &t->key_mem[bkt_key_index << t->key_size_shl];
293 if ((sig == bkt_sig) && (memcmp(key, bkt_key,
294 t->key_size) == 0)) {
295 uint8_t *data = &t->data_mem[bkt_key_index <<
298 memcpy(data, entry, t->entry_size);
300 *entry_ptr = (void *) data;
305 /* Key is not present in the bucket */
306 for (bkt_prev = NULL, bkt = bkt0; bkt != NULL; bkt_prev = bkt,
307 bkt = BUCKET_NEXT(bkt))
308 for (i = 0; i < KEYS_PER_BUCKET; i++) {
309 uint64_t bkt_sig = (uint64_t) bkt->sig[i];
312 uint32_t bkt_key_index;
313 uint8_t *bkt_key, *data;
315 /* Allocate new key */
316 if (t->key_stack_tos == 0) /* No free keys */
319 bkt_key_index = t->key_stack[
322 /* Install new key */
323 bkt_key = &t->key_mem[bkt_key_index <<
325 data = &t->data_mem[bkt_key_index <<
328 bkt->sig[i] = (uint16_t) sig;
329 bkt->key_pos[i] = bkt_key_index;
330 memcpy(bkt_key, key, t->key_size);
331 memcpy(data, entry, t->entry_size);
334 *entry_ptr = (void *) data;
339 /* Bucket full: extend bucket */
340 if ((t->bkt_ext_stack_tos > 0) && (t->key_stack_tos > 0)) {
341 uint32_t bkt_key_index;
342 uint8_t *bkt_key, *data;
344 /* Allocate new bucket ext */
345 bkt_index = t->bkt_ext_stack[--t->bkt_ext_stack_tos];
346 bkt = &t->buckets_ext[bkt_index];
348 /* Chain the new bucket ext */
349 BUCKET_NEXT_SET(bkt_prev, bkt);
350 BUCKET_NEXT_SET_NULL(bkt);
352 /* Allocate new key */
353 bkt_key_index = t->key_stack[--t->key_stack_tos];
354 bkt_key = &t->key_mem[bkt_key_index << t->key_size_shl];
356 data = &t->data_mem[bkt_key_index << t->data_size_shl];
358 /* Install new key into bucket */
359 bkt->sig[0] = (uint16_t) sig;
360 bkt->key_pos[0] = bkt_key_index;
361 memcpy(bkt_key, key, t->key_size);
362 memcpy(data, entry, t->entry_size);
365 *entry_ptr = (void *) data;
373 rte_table_hash_ext_entry_delete(void *table, void *key, int *key_found,
376 struct rte_table_hash *t = (struct rte_table_hash *) table;
377 struct bucket *bkt0, *bkt, *bkt_prev;
379 uint32_t bkt_index, i;
381 sig = t->f_hash(key, t->key_size, t->seed);
382 bkt_index = sig & t->bucket_mask;
383 bkt0 = &t->buckets[bkt_index];
384 sig = (sig >> 16) | 1LLU;
386 /* Key is present in the bucket */
387 for (bkt_prev = NULL, bkt = bkt0; bkt != NULL; bkt_prev = bkt,
388 bkt = BUCKET_NEXT(bkt))
389 for (i = 0; i < KEYS_PER_BUCKET; i++) {
390 uint64_t bkt_sig = (uint64_t) bkt->sig[i];
391 uint32_t bkt_key_index = bkt->key_pos[i];
392 uint8_t *bkt_key = &t->key_mem[bkt_key_index <<
395 if ((sig == bkt_sig) && (memcmp(key, bkt_key,
396 t->key_size) == 0)) {
397 uint8_t *data = &t->data_mem[bkt_key_index <<
400 /* Uninstall key from bucket */
404 memcpy(entry, data, t->entry_size);
407 t->key_stack[t->key_stack_tos++] =
410 /*Check if bucket is unused */
411 if ((bkt_prev != NULL) &&
412 (bkt->sig[0] == 0) && (bkt->sig[1] == 0) &&
413 (bkt->sig[2] == 0) && (bkt->sig[3] == 0)) {
415 BUCKET_NEXT_COPY(bkt_prev, bkt);
418 memset(bkt, 0, sizeof(struct bucket));
420 /* Free bucket back to buckets ext */
421 bkt_index = bkt - t->buckets_ext;
422 t->bkt_ext_stack[t->bkt_ext_stack_tos++]
430 /* Key is not present in the bucket */
435 static int rte_table_hash_ext_lookup_unoptimized(
437 struct rte_mbuf **pkts,
439 uint64_t *lookup_hit_mask,
443 struct rte_table_hash *t = (struct rte_table_hash *) table;
444 uint64_t pkts_mask_out = 0;
446 __rte_unused uint32_t n_pkts_in = __builtin_popcountll(pkts_mask);
447 RTE_TABLE_HASH_EXT_STATS_PKTS_IN_ADD(t, n_pkts_in);
449 for ( ; pkts_mask; ) {
450 struct bucket *bkt0, *bkt;
451 struct rte_mbuf *pkt;
453 uint64_t pkt_mask, sig;
454 uint32_t pkt_index, bkt_index, i;
456 pkt_index = __builtin_ctzll(pkts_mask);
457 pkt_mask = 1LLU << pkt_index;
458 pkts_mask &= ~pkt_mask;
460 pkt = pkts[pkt_index];
461 key = RTE_MBUF_METADATA_UINT8_PTR(pkt, t->key_offset);
463 sig = (uint64_t) t->f_hash(key, t->key_size, t->seed);
465 sig = RTE_MBUF_METADATA_UINT32(pkt,
466 t->signature_offset);
468 bkt_index = sig & t->bucket_mask;
469 bkt0 = &t->buckets[bkt_index];
470 sig = (sig >> 16) | 1LLU;
472 /* Key is present in the bucket */
473 for (bkt = bkt0; bkt != NULL; bkt = BUCKET_NEXT(bkt))
474 for (i = 0; i < KEYS_PER_BUCKET; i++) {
475 uint64_t bkt_sig = (uint64_t) bkt->sig[i];
476 uint32_t bkt_key_index = bkt->key_pos[i];
477 uint8_t *bkt_key = &t->key_mem[bkt_key_index <<
480 if ((sig == bkt_sig) && (memcmp(key, bkt_key,
481 t->key_size) == 0)) {
482 uint8_t *data = &t->data_mem[
483 bkt_key_index << t->data_size_shl];
485 pkts_mask_out |= pkt_mask;
486 entries[pkt_index] = (void *) data;
492 *lookup_hit_mask = pkts_mask_out;
493 RTE_TABLE_HASH_EXT_STATS_PKTS_LOOKUP_MISS(t, n_pkts_in - __builtin_popcountll(pkts_mask_out));
499 * mask = match bitmask
500 * match = at least one match
501 * match_many = more than one match
502 * match_pos = position of first match
504 *----------------------------------------
505 * mask match match_many match_pos
506 *----------------------------------------
511 *----------------------------------------
516 *----------------------------------------
521 *----------------------------------------
526 *----------------------------------------
528 * match = 1111_1111_1111_1110
529 * match_many = 1111_1110_1110_1000
530 * match_pos = 0001_0010_0001_0011__0001_0010_0001_0000
533 * match_many = 0xFEE8LLU
534 * match_pos = 0x12131210LLU
538 #define LUT_MATCH 0xFFFELLU
539 #define LUT_MATCH_MANY 0xFEE8LLU
540 #define LUT_MATCH_POS 0x12131210LLU
542 #define lookup_cmp_sig(mbuf_sig, bucket, match, match_many, match_pos) \
544 uint64_t bucket_sig[4], mask[4], mask_all; \
546 bucket_sig[0] = bucket->sig[0]; \
547 bucket_sig[1] = bucket->sig[1]; \
548 bucket_sig[2] = bucket->sig[2]; \
549 bucket_sig[3] = bucket->sig[3]; \
551 bucket_sig[0] ^= mbuf_sig; \
552 bucket_sig[1] ^= mbuf_sig; \
553 bucket_sig[2] ^= mbuf_sig; \
554 bucket_sig[3] ^= mbuf_sig; \
561 if (bucket_sig[0] == 0) \
563 if (bucket_sig[1] == 0) \
565 if (bucket_sig[2] == 0) \
567 if (bucket_sig[3] == 0) \
570 mask_all = (mask[0] | mask[1]) | (mask[2] | mask[3]); \
572 match = (LUT_MATCH >> mask_all) & 1; \
573 match_many = (LUT_MATCH_MANY >> mask_all) & 1; \
574 match_pos = (LUT_MATCH_POS >> (mask_all << 1)) & 3; \
577 #define lookup_cmp_key(mbuf, key, match_key, f) \
579 uint64_t *pkt_key = RTE_MBUF_METADATA_UINT64_PTR(mbuf, f->key_offset);\
580 uint64_t *bkt_key = (uint64_t *) key; \
582 switch (f->key_size) { \
585 uint64_t xor = pkt_key[0] ^ bkt_key[0]; \
594 uint64_t xor[2], or; \
596 xor[0] = pkt_key[0] ^ bkt_key[0]; \
597 xor[1] = pkt_key[1] ^ bkt_key[1]; \
598 or = xor[0] | xor[1]; \
607 uint64_t xor[4], or; \
609 xor[0] = pkt_key[0] ^ bkt_key[0]; \
610 xor[1] = pkt_key[1] ^ bkt_key[1]; \
611 xor[2] = pkt_key[2] ^ bkt_key[2]; \
612 xor[3] = pkt_key[3] ^ bkt_key[3]; \
613 or = xor[0] | xor[1] | xor[2] | xor[3]; \
622 uint64_t xor[8], or; \
624 xor[0] = pkt_key[0] ^ bkt_key[0]; \
625 xor[1] = pkt_key[1] ^ bkt_key[1]; \
626 xor[2] = pkt_key[2] ^ bkt_key[2]; \
627 xor[3] = pkt_key[3] ^ bkt_key[3]; \
628 xor[4] = pkt_key[4] ^ bkt_key[4]; \
629 xor[5] = pkt_key[5] ^ bkt_key[5]; \
630 xor[6] = pkt_key[6] ^ bkt_key[6]; \
631 xor[7] = pkt_key[7] ^ bkt_key[7]; \
632 or = xor[0] | xor[1] | xor[2] | xor[3] | \
633 xor[4] | xor[5] | xor[6] | xor[7]; \
642 if (memcmp(pkt_key, bkt_key, f->key_size) == 0) \
647 #define lookup2_stage0(t, g, pkts, pkts_mask, pkt00_index, pkt01_index) \
649 uint64_t pkt00_mask, pkt01_mask; \
650 struct rte_mbuf *mbuf00, *mbuf01; \
652 pkt00_index = __builtin_ctzll(pkts_mask); \
653 pkt00_mask = 1LLU << pkt00_index; \
654 pkts_mask &= ~pkt00_mask; \
655 mbuf00 = pkts[pkt00_index]; \
657 pkt01_index = __builtin_ctzll(pkts_mask); \
658 pkt01_mask = 1LLU << pkt01_index; \
659 pkts_mask &= ~pkt01_mask; \
660 mbuf01 = pkts[pkt01_index]; \
662 rte_prefetch0(RTE_MBUF_METADATA_UINT8_PTR(mbuf00, 0)); \
663 rte_prefetch0(RTE_MBUF_METADATA_UINT8_PTR(mbuf01, 0)); \
666 #define lookup2_stage0_with_odd_support(t, g, pkts, pkts_mask, pkt00_index, \
669 uint64_t pkt00_mask, pkt01_mask; \
670 struct rte_mbuf *mbuf00, *mbuf01; \
672 pkt00_index = __builtin_ctzll(pkts_mask); \
673 pkt00_mask = 1LLU << pkt00_index; \
674 pkts_mask &= ~pkt00_mask; \
675 mbuf00 = pkts[pkt00_index]; \
677 pkt01_index = __builtin_ctzll(pkts_mask); \
678 if (pkts_mask == 0) \
679 pkt01_index = pkt00_index; \
680 pkt01_mask = 1LLU << pkt01_index; \
681 pkts_mask &= ~pkt01_mask; \
682 mbuf01 = pkts[pkt01_index]; \
684 rte_prefetch0(RTE_MBUF_METADATA_UINT8_PTR(mbuf00, 0)); \
685 rte_prefetch0(RTE_MBUF_METADATA_UINT8_PTR(mbuf01, 0)); \
688 #define lookup2_stage1(t, g, pkts, pkt10_index, pkt11_index) \
690 struct grinder *g10, *g11; \
691 uint64_t sig10, sig11, bkt10_index, bkt11_index; \
692 struct rte_mbuf *mbuf10, *mbuf11; \
693 struct bucket *bkt10, *bkt11, *buckets = t->buckets; \
694 uint64_t bucket_mask = t->bucket_mask; \
695 uint32_t signature_offset = t->signature_offset; \
697 mbuf10 = pkts[pkt10_index]; \
698 sig10 = (uint64_t) RTE_MBUF_METADATA_UINT32(mbuf10, signature_offset);\
699 bkt10_index = sig10 & bucket_mask; \
700 bkt10 = &buckets[bkt10_index]; \
702 mbuf11 = pkts[pkt11_index]; \
703 sig11 = (uint64_t) RTE_MBUF_METADATA_UINT32(mbuf11, signature_offset);\
704 bkt11_index = sig11 & bucket_mask; \
705 bkt11 = &buckets[bkt11_index]; \
707 rte_prefetch0(bkt10); \
708 rte_prefetch0(bkt11); \
710 g10 = &g[pkt10_index]; \
714 g11 = &g[pkt11_index]; \
719 #define lookup2_stage1_dosig(t, g, pkts, pkt10_index, pkt11_index) \
721 struct grinder *g10, *g11; \
722 uint64_t sig10, sig11, bkt10_index, bkt11_index; \
723 struct rte_mbuf *mbuf10, *mbuf11; \
724 struct bucket *bkt10, *bkt11, *buckets = t->buckets; \
725 uint8_t *key10, *key11; \
726 uint64_t bucket_mask = t->bucket_mask; \
727 rte_table_hash_op_hash f_hash = t->f_hash; \
728 uint64_t seed = t->seed; \
729 uint32_t key_size = t->key_size; \
730 uint32_t key_offset = t->key_offset; \
732 mbuf10 = pkts[pkt10_index]; \
733 key10 = RTE_MBUF_METADATA_UINT8_PTR(mbuf10, key_offset); \
734 sig10 = (uint64_t) f_hash(key10, key_size, seed); \
735 bkt10_index = sig10 & bucket_mask; \
736 bkt10 = &buckets[bkt10_index]; \
738 mbuf11 = pkts[pkt11_index]; \
739 key11 = RTE_MBUF_METADATA_UINT8_PTR(mbuf11, key_offset); \
740 sig11 = (uint64_t) f_hash(key11, key_size, seed); \
741 bkt11_index = sig11 & bucket_mask; \
742 bkt11 = &buckets[bkt11_index]; \
744 rte_prefetch0(bkt10); \
745 rte_prefetch0(bkt11); \
747 g10 = &g[pkt10_index]; \
751 g11 = &g[pkt11_index]; \
756 #define lookup2_stage2(t, g, pkt20_index, pkt21_index, pkts_mask_match_many)\
758 struct grinder *g20, *g21; \
759 uint64_t sig20, sig21; \
760 struct bucket *bkt20, *bkt21; \
761 uint8_t *key20, *key21, *key_mem = t->key_mem; \
762 uint64_t match20, match21, match_many20, match_many21; \
763 uint64_t match_pos20, match_pos21; \
764 uint32_t key20_index, key21_index, key_size_shl = t->key_size_shl;\
766 g20 = &g[pkt20_index]; \
769 sig20 = (sig20 >> 16) | 1LLU; \
770 lookup_cmp_sig(sig20, bkt20, match20, match_many20, match_pos20);\
771 match20 <<= pkt20_index; \
772 match_many20 |= BUCKET_NEXT_VALID(bkt20); \
773 match_many20 <<= pkt20_index; \
774 key20_index = bkt20->key_pos[match_pos20]; \
775 key20 = &key_mem[key20_index << key_size_shl]; \
777 g21 = &g[pkt21_index]; \
780 sig21 = (sig21 >> 16) | 1LLU; \
781 lookup_cmp_sig(sig21, bkt21, match21, match_many21, match_pos21);\
782 match21 <<= pkt21_index; \
783 match_many21 |= BUCKET_NEXT_VALID(bkt21); \
784 match_many21 <<= pkt21_index; \
785 key21_index = bkt21->key_pos[match_pos21]; \
786 key21 = &key_mem[key21_index << key_size_shl]; \
788 rte_prefetch0(key20); \
789 rte_prefetch0(key21); \
791 pkts_mask_match_many |= match_many20 | match_many21; \
793 g20->match = match20; \
794 g20->key_index = key20_index; \
796 g21->match = match21; \
797 g21->key_index = key21_index; \
800 #define lookup2_stage3(t, g, pkts, pkt30_index, pkt31_index, pkts_mask_out, \
803 struct grinder *g30, *g31; \
804 struct rte_mbuf *mbuf30, *mbuf31; \
805 uint8_t *key30, *key31, *key_mem = t->key_mem; \
806 uint8_t *data30, *data31, *data_mem = t->data_mem; \
807 uint64_t match30, match31, match_key30, match_key31, match_keys;\
808 uint32_t key30_index, key31_index; \
809 uint32_t key_size_shl = t->key_size_shl; \
810 uint32_t data_size_shl = t->data_size_shl; \
812 mbuf30 = pkts[pkt30_index]; \
813 g30 = &g[pkt30_index]; \
814 match30 = g30->match; \
815 key30_index = g30->key_index; \
816 key30 = &key_mem[key30_index << key_size_shl]; \
817 lookup_cmp_key(mbuf30, key30, match_key30, t); \
818 match_key30 <<= pkt30_index; \
819 match_key30 &= match30; \
820 data30 = &data_mem[key30_index << data_size_shl]; \
821 entries[pkt30_index] = data30; \
823 mbuf31 = pkts[pkt31_index]; \
824 g31 = &g[pkt31_index]; \
825 match31 = g31->match; \
826 key31_index = g31->key_index; \
827 key31 = &key_mem[key31_index << key_size_shl]; \
828 lookup_cmp_key(mbuf31, key31, match_key31, t); \
829 match_key31 <<= pkt31_index; \
830 match_key31 &= match31; \
831 data31 = &data_mem[key31_index << data_size_shl]; \
832 entries[pkt31_index] = data31; \
834 rte_prefetch0(data30); \
835 rte_prefetch0(data31); \
837 match_keys = match_key30 | match_key31; \
838 pkts_mask_out |= match_keys; \
842 * The lookup function implements a 4-stage pipeline, with each stage processing
843 * two different packets. The purpose of pipelined implementation is to hide the
844 * latency of prefetching the data structures and loosen the data dependency
845 * between instructions.
847 * p00 _______ p10 _______ p20 _______ p30 _______
848 *----->| |----->| |----->| |----->| |----->
849 * | 0 | | 1 | | 2 | | 3 |
850 *----->|_______|----->|_______|----->|_______|----->|_______|----->
853 * The naming convention is:
854 * pXY = packet Y of stage X, X = 0 .. 3, Y = 0 .. 1
857 static int rte_table_hash_ext_lookup(
859 struct rte_mbuf **pkts,
861 uint64_t *lookup_hit_mask,
864 struct rte_table_hash *t = (struct rte_table_hash *) table;
865 struct grinder *g = t->grinders;
866 uint64_t pkt00_index, pkt01_index, pkt10_index, pkt11_index;
867 uint64_t pkt20_index, pkt21_index, pkt30_index, pkt31_index;
868 uint64_t pkts_mask_out = 0, pkts_mask_match_many = 0;
871 __rte_unused uint32_t n_pkts_in = __builtin_popcountll(pkts_mask);
872 RTE_TABLE_HASH_EXT_STATS_PKTS_IN_ADD(t, n_pkts_in);
874 /* Cannot run the pipeline with less than 7 packets */
875 if (__builtin_popcountll(pkts_mask) < 7)
876 return rte_table_hash_ext_lookup_unoptimized(table, pkts,
877 pkts_mask, lookup_hit_mask, entries, 0);
879 /* Pipeline stage 0 */
880 lookup2_stage0(t, g, pkts, pkts_mask, pkt00_index, pkt01_index);
883 pkt10_index = pkt00_index;
884 pkt11_index = pkt01_index;
886 /* Pipeline stage 0 */
887 lookup2_stage0(t, g, pkts, pkts_mask, pkt00_index, pkt01_index);
889 /* Pipeline stage 1 */
890 lookup2_stage1(t, g, pkts, pkt10_index, pkt11_index);
893 pkt20_index = pkt10_index;
894 pkt21_index = pkt11_index;
895 pkt10_index = pkt00_index;
896 pkt11_index = pkt01_index;
898 /* Pipeline stage 0 */
899 lookup2_stage0(t, g, pkts, pkts_mask, pkt00_index, pkt01_index);
901 /* Pipeline stage 1 */
902 lookup2_stage1(t, g, pkts, pkt10_index, pkt11_index);
904 /* Pipeline stage 2 */
905 lookup2_stage2(t, g, pkt20_index, pkt21_index, pkts_mask_match_many);
911 for ( ; pkts_mask; ) {
913 pkt30_index = pkt20_index;
914 pkt31_index = pkt21_index;
915 pkt20_index = pkt10_index;
916 pkt21_index = pkt11_index;
917 pkt10_index = pkt00_index;
918 pkt11_index = pkt01_index;
920 /* Pipeline stage 0 */
921 lookup2_stage0_with_odd_support(t, g, pkts, pkts_mask,
922 pkt00_index, pkt01_index);
924 /* Pipeline stage 1 */
925 lookup2_stage1(t, g, pkts, pkt10_index, pkt11_index);
927 /* Pipeline stage 2 */
928 lookup2_stage2(t, g, pkt20_index, pkt21_index,
929 pkts_mask_match_many);
931 /* Pipeline stage 3 */
932 lookup2_stage3(t, g, pkts, pkt30_index, pkt31_index,
933 pkts_mask_out, entries);
937 pkt30_index = pkt20_index;
938 pkt31_index = pkt21_index;
939 pkt20_index = pkt10_index;
940 pkt21_index = pkt11_index;
941 pkt10_index = pkt00_index;
942 pkt11_index = pkt01_index;
944 /* Pipeline stage 1 */
945 lookup2_stage1(t, g, pkts, pkt10_index, pkt11_index);
947 /* Pipeline stage 2 */
948 lookup2_stage2(t, g, pkt20_index, pkt21_index, pkts_mask_match_many);
950 /* Pipeline stage 3 */
951 lookup2_stage3(t, g, pkts, pkt30_index, pkt31_index, pkts_mask_out,
955 pkt30_index = pkt20_index;
956 pkt31_index = pkt21_index;
957 pkt20_index = pkt10_index;
958 pkt21_index = pkt11_index;
960 /* Pipeline stage 2 */
961 lookup2_stage2(t, g, pkt20_index, pkt21_index, pkts_mask_match_many);
963 /* Pipeline stage 3 */
964 lookup2_stage3(t, g, pkts, pkt30_index, pkt31_index, pkts_mask_out,
968 pkt30_index = pkt20_index;
969 pkt31_index = pkt21_index;
971 /* Pipeline stage 3 */
972 lookup2_stage3(t, g, pkts, pkt30_index, pkt31_index, pkts_mask_out,
976 pkts_mask_match_many &= ~pkts_mask_out;
977 if (pkts_mask_match_many) {
978 uint64_t pkts_mask_out_slow = 0;
980 status = rte_table_hash_ext_lookup_unoptimized(table, pkts,
981 pkts_mask_match_many, &pkts_mask_out_slow, entries, 0);
982 pkts_mask_out |= pkts_mask_out_slow;
985 *lookup_hit_mask = pkts_mask_out;
986 RTE_TABLE_HASH_EXT_STATS_PKTS_LOOKUP_MISS(t, n_pkts_in - __builtin_popcountll(pkts_mask_out));
990 static int rte_table_hash_ext_lookup_dosig(
992 struct rte_mbuf **pkts,
994 uint64_t *lookup_hit_mask,
997 struct rte_table_hash *t = (struct rte_table_hash *) table;
998 struct grinder *g = t->grinders;
999 uint64_t pkt00_index, pkt01_index, pkt10_index, pkt11_index;
1000 uint64_t pkt20_index, pkt21_index, pkt30_index, pkt31_index;
1001 uint64_t pkts_mask_out = 0, pkts_mask_match_many = 0;
1004 __rte_unused uint32_t n_pkts_in = __builtin_popcountll(pkts_mask);
1005 RTE_TABLE_HASH_EXT_STATS_PKTS_IN_ADD(t, n_pkts_in);
1007 /* Cannot run the pipeline with less than 7 packets */
1008 if (__builtin_popcountll(pkts_mask) < 7)
1009 return rte_table_hash_ext_lookup_unoptimized(table, pkts,
1010 pkts_mask, lookup_hit_mask, entries, 1);
1012 /* Pipeline stage 0 */
1013 lookup2_stage0(t, g, pkts, pkts_mask, pkt00_index, pkt01_index);
1016 pkt10_index = pkt00_index;
1017 pkt11_index = pkt01_index;
1019 /* Pipeline stage 0 */
1020 lookup2_stage0(t, g, pkts, pkts_mask, pkt00_index, pkt01_index);
1022 /* Pipeline stage 1 */
1023 lookup2_stage1_dosig(t, g, pkts, pkt10_index, pkt11_index);
1026 pkt20_index = pkt10_index;
1027 pkt21_index = pkt11_index;
1028 pkt10_index = pkt00_index;
1029 pkt11_index = pkt01_index;
1031 /* Pipeline stage 0 */
1032 lookup2_stage0(t, g, pkts, pkts_mask, pkt00_index, pkt01_index);
1034 /* Pipeline stage 1 */
1035 lookup2_stage1_dosig(t, g, pkts, pkt10_index, pkt11_index);
1037 /* Pipeline stage 2 */
1038 lookup2_stage2(t, g, pkt20_index, pkt21_index, pkts_mask_match_many);
1044 for ( ; pkts_mask; ) {
1046 pkt30_index = pkt20_index;
1047 pkt31_index = pkt21_index;
1048 pkt20_index = pkt10_index;
1049 pkt21_index = pkt11_index;
1050 pkt10_index = pkt00_index;
1051 pkt11_index = pkt01_index;
1053 /* Pipeline stage 0 */
1054 lookup2_stage0_with_odd_support(t, g, pkts, pkts_mask,
1055 pkt00_index, pkt01_index);
1057 /* Pipeline stage 1 */
1058 lookup2_stage1_dosig(t, g, pkts, pkt10_index, pkt11_index);
1060 /* Pipeline stage 2 */
1061 lookup2_stage2(t, g, pkt20_index, pkt21_index,
1062 pkts_mask_match_many);
1064 /* Pipeline stage 3 */
1065 lookup2_stage3(t, g, pkts, pkt30_index, pkt31_index,
1066 pkts_mask_out, entries);
1070 pkt30_index = pkt20_index;
1071 pkt31_index = pkt21_index;
1072 pkt20_index = pkt10_index;
1073 pkt21_index = pkt11_index;
1074 pkt10_index = pkt00_index;
1075 pkt11_index = pkt01_index;
1077 /* Pipeline stage 1 */
1078 lookup2_stage1_dosig(t, g, pkts, pkt10_index, pkt11_index);
1080 /* Pipeline stage 2 */
1081 lookup2_stage2(t, g, pkt20_index, pkt21_index, pkts_mask_match_many);
1083 /* Pipeline stage 3 */
1084 lookup2_stage3(t, g, pkts, pkt30_index, pkt31_index, pkts_mask_out,
1088 pkt30_index = pkt20_index;
1089 pkt31_index = pkt21_index;
1090 pkt20_index = pkt10_index;
1091 pkt21_index = pkt11_index;
1093 /* Pipeline stage 2 */
1094 lookup2_stage2(t, g, pkt20_index, pkt21_index, pkts_mask_match_many);
1096 /* Pipeline stage 3 */
1097 lookup2_stage3(t, g, pkts, pkt30_index, pkt31_index, pkts_mask_out,
1101 pkt30_index = pkt20_index;
1102 pkt31_index = pkt21_index;
1104 /* Pipeline stage 3 */
1105 lookup2_stage3(t, g, pkts, pkt30_index, pkt31_index, pkts_mask_out,
1109 pkts_mask_match_many &= ~pkts_mask_out;
1110 if (pkts_mask_match_many) {
1111 uint64_t pkts_mask_out_slow = 0;
1113 status = rte_table_hash_ext_lookup_unoptimized(table, pkts,
1114 pkts_mask_match_many, &pkts_mask_out_slow, entries, 1);
1115 pkts_mask_out |= pkts_mask_out_slow;
1118 *lookup_hit_mask = pkts_mask_out;
1119 RTE_TABLE_HASH_EXT_STATS_PKTS_LOOKUP_MISS(t, n_pkts_in - __builtin_popcountll(pkts_mask_out));
1124 rte_table_hash_ext_stats_read(void *table, struct rte_table_stats *stats, int clear)
1126 struct rte_table_hash *t = (struct rte_table_hash *) table;
1129 memcpy(stats, &t->stats, sizeof(t->stats));
1132 memset(&t->stats, 0, sizeof(t->stats));
1137 struct rte_table_ops rte_table_hash_ext_ops = {
1138 .f_create = rte_table_hash_ext_create,
1139 .f_free = rte_table_hash_ext_free,
1140 .f_add = rte_table_hash_ext_entry_add,
1141 .f_delete = rte_table_hash_ext_entry_delete,
1142 .f_lookup = rte_table_hash_ext_lookup,
1143 .f_stats = rte_table_hash_ext_stats_read,
1146 struct rte_table_ops rte_table_hash_ext_dosig_ops = {
1147 .f_create = rte_table_hash_ext_create,
1148 .f_free = rte_table_hash_ext_free,
1149 .f_add = rte_table_hash_ext_entry_add,
1150 .f_delete = rte_table_hash_ext_entry_delete,
1151 .f_lookup = rte_table_hash_ext_lookup_dosig,
1152 .f_stats = rte_table_hash_ext_stats_read,