1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2015 Intel Corporation
9 #include <rte_cycles.h>
10 #include <rte_malloc.h>
12 #include <rte_hash_crc.h>
13 #include <rte_jhash.h>
14 #include <rte_fbk_hash.h>
15 #include <rte_random.h>
16 #include <rte_string_fns.h>
20 #define MAX_ENTRIES (1 << 19)
21 #define KEYS_TO_ADD (MAX_ENTRIES)
22 #define ADD_PERCENT 0.75 /* 75% table utilization */
23 #define NUM_LOOKUPS (KEYS_TO_ADD * 5) /* Loop among keys added, several times */
24 /* BUCKET_SIZE should be same as RTE_HASH_BUCKET_ENTRIES in rte_hash library */
26 #define NUM_BUCKETS (MAX_ENTRIES / BUCKET_SIZE)
27 #define MAX_KEYSIZE 64
28 #define NUM_KEYSIZES 10
29 #define NUM_SHUFFLES 10
40 static uint32_t hashtest_key_lens[] = {
41 /* standard key sizes */
43 /* IPv4 SRC + DST + protocol, unpadded */
45 /* IPv4 5-tuple, unpadded */
47 /* IPv6 5-tuple, unpadded */
49 /* IPv6 5-tuple, padded to 8-byte boundary */
53 struct rte_hash *h[NUM_KEYSIZES];
55 /* Array that stores if a slot is full */
56 uint8_t slot_taken[MAX_ENTRIES];
58 /* Array to store number of cycles per operation */
59 uint64_t cycles[NUM_KEYSIZES][NUM_OPERATIONS][2][2];
61 /* Array to store all input keys */
62 uint8_t keys[KEYS_TO_ADD][MAX_KEYSIZE];
64 /* Array to store the precomputed hash for 'keys' */
65 hash_sig_t signatures[KEYS_TO_ADD];
67 /* Array to store how many busy entries have each bucket */
68 uint8_t buckets[NUM_BUCKETS];
70 /* Array to store the positions where keys are added */
71 int32_t positions[KEYS_TO_ADD];
73 /* Parameters used for hash table in unit test functions. */
74 static struct rte_hash_parameters ut_params = {
75 .entries = MAX_ENTRIES,
76 .hash_func = rte_jhash,
77 .hash_func_init_val = 0,
81 create_table(unsigned int with_data, unsigned int table_index,
82 unsigned int with_locks, unsigned int ext)
84 char name[RTE_HASH_NAMESIZE];
87 /* Table will store 8-byte data */
88 sprintf(name, "test_hash%d_data", hashtest_key_lens[table_index]);
90 sprintf(name, "test_hash%d", hashtest_key_lens[table_index]);
94 ut_params.extra_flag =
95 RTE_HASH_EXTRA_FLAGS_TRANS_MEM_SUPPORT
96 | RTE_HASH_EXTRA_FLAGS_RW_CONCURRENCY;
98 ut_params.extra_flag = 0;
101 ut_params.extra_flag |= RTE_HASH_EXTRA_FLAGS_EXT_TABLE;
103 ut_params.name = name;
104 ut_params.key_len = hashtest_key_lens[table_index];
105 ut_params.socket_id = rte_socket_id();
106 h[table_index] = rte_hash_find_existing(name);
107 if (h[table_index] != NULL)
109 * If table was already created, free it to create it again,
110 * so we force it is empty
112 rte_hash_free(h[table_index]);
113 h[table_index] = rte_hash_create(&ut_params);
114 if (h[table_index] == NULL) {
115 printf("Error creating table\n");
122 /* Shuffle the keys that have been added, so lookups will be totally random */
124 shuffle_input_keys(unsigned int table_index, unsigned int ext)
128 uint8_t temp_key[MAX_KEYSIZE];
129 hash_sig_t temp_signature;
130 int32_t temp_position;
131 unsigned int keys_to_add;
134 keys_to_add = KEYS_TO_ADD * ADD_PERCENT;
136 keys_to_add = KEYS_TO_ADD;
138 for (i = keys_to_add - 1; i > 0; i--) {
139 swap_idx = rte_rand() % i;
141 memcpy(temp_key, keys[i], hashtest_key_lens[table_index]);
142 temp_signature = signatures[i];
143 temp_position = positions[i];
145 memcpy(keys[i], keys[swap_idx], hashtest_key_lens[table_index]);
146 signatures[i] = signatures[swap_idx];
147 positions[i] = positions[swap_idx];
149 memcpy(keys[swap_idx], temp_key, hashtest_key_lens[table_index]);
150 signatures[swap_idx] = temp_signature;
151 positions[swap_idx] = temp_position;
156 * Looks for random keys which
157 * ALL can fit in hash table (no errors)
160 get_input_keys(unsigned int with_pushes, unsigned int table_index,
164 unsigned bucket_idx, incr, success = 1;
167 const uint32_t bucket_bitmask = NUM_BUCKETS - 1;
168 unsigned int keys_to_add;
171 keys_to_add = KEYS_TO_ADD * ADD_PERCENT;
173 keys_to_add = KEYS_TO_ADD;
174 /* Reset all arrays */
175 for (i = 0; i < MAX_ENTRIES; i++)
178 for (i = 0; i < NUM_BUCKETS; i++)
181 for (j = 0; j < hashtest_key_lens[table_index]; j++)
185 * Add only entries that are not duplicated and that fits in the table
186 * (cannot store more than BUCKET_SIZE entries in a bucket).
187 * Regardless a key has been added correctly or not (success),
188 * the next one to try will be increased by 1.
190 for (i = 0; i < keys_to_add;) {
194 /* Overflow, need to increment the next byte */
197 for (j = 1; j < hashtest_key_lens[table_index]; j++) {
198 /* Do not increase next byte */
201 keys[i][j] = keys[i - 1][j];
203 keys[i][j] = keys[i][j];
204 /* Increase next byte by one */
207 keys[i][j] = keys[i-1][j] + 1;
209 keys[i][j] = keys[i][j] + 1;
218 signatures[i] = rte_hash_hash(h[table_index], keys[i]);
219 bucket_idx = signatures[i] & bucket_bitmask;
221 * If we are not inserting keys in secondary location,
222 * when bucket is full, do not try to insert the key
224 if (with_pushes == 0)
225 if (buckets[bucket_idx] == BUCKET_SIZE)
228 /* If key can be added, leave in successful key arrays "keys" */
229 ret = rte_hash_add_key_with_hash(h[table_index], keys[i],
232 /* If key is already added, ignore the entry and do not store */
236 /* Store the returned position and mark slot as taken */
239 buckets[bucket_idx]++;
246 /* Reset the table, so we can measure the time to add all the entries */
247 rte_hash_free(h[table_index]);
248 h[table_index] = rte_hash_create(&ut_params);
254 timed_adds(unsigned int with_hash, unsigned int with_data,
255 unsigned int table_index, unsigned int ext)
258 const uint64_t start_tsc = rte_rdtsc();
261 unsigned int keys_to_add;
263 keys_to_add = KEYS_TO_ADD * ADD_PERCENT;
265 keys_to_add = KEYS_TO_ADD;
267 for (i = 0; i < keys_to_add; i++) {
268 data = (void *) ((uintptr_t) signatures[i]);
269 if (with_hash && with_data) {
270 ret = rte_hash_add_key_with_hash_data(h[table_index],
271 (const void *) keys[i],
272 signatures[i], data);
274 printf("H+D: Failed to add key number %u\n", i);
277 } else if (with_hash && !with_data) {
278 ret = rte_hash_add_key_with_hash(h[table_index],
279 (const void *) keys[i],
284 printf("H: Failed to add key number %u\n", i);
287 } else if (!with_hash && with_data) {
288 ret = rte_hash_add_key_data(h[table_index],
289 (const void *) keys[i],
292 printf("D: Failed to add key number %u\n", i);
296 ret = rte_hash_add_key(h[table_index], keys[i]);
300 printf("Failed to add key number %u\n", i);
306 const uint64_t end_tsc = rte_rdtsc();
307 const uint64_t time_taken = end_tsc - start_tsc;
309 cycles[table_index][ADD][with_hash][with_data] = time_taken/keys_to_add;
315 timed_lookups(unsigned int with_hash, unsigned int with_data,
316 unsigned int table_index, unsigned int ext)
319 const uint64_t start_tsc = rte_rdtsc();
323 unsigned int keys_to_add, num_lookups;
326 keys_to_add = KEYS_TO_ADD * ADD_PERCENT;
327 num_lookups = NUM_LOOKUPS * ADD_PERCENT;
329 keys_to_add = KEYS_TO_ADD;
330 num_lookups = NUM_LOOKUPS;
332 for (i = 0; i < num_lookups / keys_to_add; i++) {
333 for (j = 0; j < keys_to_add; j++) {
334 if (with_hash && with_data) {
335 ret = rte_hash_lookup_with_hash_data(h[table_index],
336 (const void *) keys[j],
337 signatures[j], &ret_data);
339 printf("Key number %u was not found\n", j);
342 expected_data = (void *) ((uintptr_t) signatures[j]);
343 if (ret_data != expected_data) {
344 printf("Data returned for key number %u is %p,"
345 " but should be %p\n", j, ret_data,
349 } else if (with_hash && !with_data) {
350 ret = rte_hash_lookup_with_hash(h[table_index],
351 (const void *) keys[j],
353 if (ret < 0 || ret != positions[j]) {
354 printf("Key looked up in %d, should be in %d\n",
358 } else if (!with_hash && with_data) {
359 ret = rte_hash_lookup_data(h[table_index],
360 (const void *) keys[j], &ret_data);
362 printf("Key number %u was not found\n", j);
365 expected_data = (void *) ((uintptr_t) signatures[j]);
366 if (ret_data != expected_data) {
367 printf("Data returned for key number %u is %p,"
368 " but should be %p\n", j, ret_data,
373 ret = rte_hash_lookup(h[table_index], keys[j]);
374 if (ret < 0 || ret != positions[j]) {
375 printf("Key looked up in %d, should be in %d\n",
383 const uint64_t end_tsc = rte_rdtsc();
384 const uint64_t time_taken = end_tsc - start_tsc;
386 cycles[table_index][LOOKUP][with_hash][with_data] = time_taken/num_lookups;
392 timed_lookups_multi(unsigned int with_data, unsigned int table_index,
396 int32_t positions_burst[BURST_SIZE];
397 const void *keys_burst[BURST_SIZE];
398 void *expected_data[BURST_SIZE];
399 void *ret_data[BURST_SIZE];
402 unsigned int keys_to_add, num_lookups;
405 keys_to_add = KEYS_TO_ADD * ADD_PERCENT;
406 num_lookups = NUM_LOOKUPS * ADD_PERCENT;
408 keys_to_add = KEYS_TO_ADD;
409 num_lookups = NUM_LOOKUPS;
412 const uint64_t start_tsc = rte_rdtsc();
414 for (i = 0; i < num_lookups/keys_to_add; i++) {
415 for (j = 0; j < keys_to_add/BURST_SIZE; j++) {
416 for (k = 0; k < BURST_SIZE; k++)
417 keys_burst[k] = keys[j * BURST_SIZE + k];
419 ret = rte_hash_lookup_bulk_data(h[table_index],
420 (const void **) keys_burst,
424 if (ret != BURST_SIZE) {
425 printf("Expect to find %u keys,"
426 " but found %d\n", BURST_SIZE, ret);
429 for (k = 0; k < BURST_SIZE; k++) {
430 if ((hit_mask & (1ULL << k)) == 0) {
431 printf("Key number %u not found\n",
435 expected_data[k] = (void *) ((uintptr_t) signatures[j * BURST_SIZE + k]);
436 if (ret_data[k] != expected_data[k]) {
437 printf("Data returned for key number %u is %p,"
438 " but should be %p\n", j * BURST_SIZE + k,
439 ret_data[k], expected_data[k]);
444 rte_hash_lookup_bulk(h[table_index],
445 (const void **) keys_burst,
448 for (k = 0; k < BURST_SIZE; k++) {
449 if (positions_burst[k] != positions[j * BURST_SIZE + k]) {
450 printf("Key looked up in %d, should be in %d\n",
452 positions[j * BURST_SIZE + k]);
460 const uint64_t end_tsc = rte_rdtsc();
461 const uint64_t time_taken = end_tsc - start_tsc;
463 cycles[table_index][LOOKUP_MULTI][0][with_data] = time_taken/num_lookups;
469 timed_deletes(unsigned int with_hash, unsigned int with_data,
470 unsigned int table_index, unsigned int ext)
473 const uint64_t start_tsc = rte_rdtsc();
475 unsigned int keys_to_add;
477 keys_to_add = KEYS_TO_ADD * ADD_PERCENT;
479 keys_to_add = KEYS_TO_ADD;
481 for (i = 0; i < keys_to_add; i++) {
482 /* There are no delete functions with data, so just call two functions */
484 ret = rte_hash_del_key_with_hash(h[table_index],
485 (const void *) keys[i],
488 ret = rte_hash_del_key(h[table_index],
489 (const void *) keys[i]);
493 printf("Failed to delete key number %u\n", i);
498 const uint64_t end_tsc = rte_rdtsc();
499 const uint64_t time_taken = end_tsc - start_tsc;
501 cycles[table_index][DELETE][with_hash][with_data] = time_taken/keys_to_add;
507 free_table(unsigned table_index)
509 rte_hash_free(h[table_index]);
513 reset_table(unsigned table_index)
515 rte_hash_reset(h[table_index]);
519 run_all_tbl_perf_tests(unsigned int with_pushes, unsigned int with_locks,
522 unsigned i, j, with_data, with_hash;
524 printf("Measuring performance, please wait");
527 for (with_data = 0; with_data <= 1; with_data++) {
528 for (i = 0; i < NUM_KEYSIZES; i++) {
529 if (create_table(with_data, i, with_locks, ext) < 0)
532 if (get_input_keys(with_pushes, i, ext) < 0)
534 for (with_hash = 0; with_hash <= 1; with_hash++) {
535 if (timed_adds(with_hash, with_data, i, ext) < 0)
538 for (j = 0; j < NUM_SHUFFLES; j++)
539 shuffle_input_keys(i, ext);
541 if (timed_lookups(with_hash, with_data, i, ext) < 0)
544 if (timed_lookups_multi(with_data, i, ext) < 0)
547 if (timed_deletes(with_hash, with_data, i, ext) < 0)
550 /* Print a dot to show progress on operations */
560 printf("\nResults (in CPU cycles/operation)\n");
561 printf("-----------------------------------\n");
562 for (with_data = 0; with_data <= 1; with_data++) {
564 printf("\n Operations with 8-byte data\n");
566 printf("\n Operations without data\n");
567 for (with_hash = 0; with_hash <= 1; with_hash++) {
569 printf("\nWith pre-computed hash values\n");
571 printf("\nWithout pre-computed hash values\n");
573 printf("\n%-18s%-18s%-18s%-18s%-18s\n",
574 "Keysize", "Add", "Lookup", "Lookup_bulk", "Delete");
575 for (i = 0; i < NUM_KEYSIZES; i++) {
576 printf("%-18d", hashtest_key_lens[i]);
577 for (j = 0; j < NUM_OPERATIONS; j++)
578 printf("%-18"PRIu64, cycles[i][j][with_hash][with_data]);
586 /* Control operation of performance testing of fbk hash. */
587 #define LOAD_FACTOR 0.667 /* How full to make the hash table. */
588 #define TEST_SIZE 1000000 /* How many operations to time. */
589 #define TEST_ITERATIONS 30 /* How many measurements to take. */
590 #define ENTRIES (1 << 15) /* How many entries. */
593 fbk_hash_perf_test(void)
595 struct rte_fbk_hash_params params = {
596 .name = "fbk_hash_test",
598 .entries_per_bucket = 4,
599 .socket_id = rte_socket_id(),
601 struct rte_fbk_hash_table *handle = NULL;
602 uint32_t *keys = NULL;
603 unsigned indexes[TEST_SIZE];
604 uint64_t lookup_time = 0;
611 handle = rte_fbk_hash_create(¶ms);
612 if (handle == NULL) {
613 printf("Error creating table\n");
617 keys = rte_zmalloc(NULL, ENTRIES * sizeof(*keys), 0);
619 printf("fbk hash: memory allocation for key store failed\n");
623 /* Generate random keys and values. */
624 for (i = 0; i < ENTRIES; i++) {
625 key = (uint32_t)rte_rand();
626 key = ((uint64_t)key << 32) | (uint64_t)rte_rand();
627 val = (uint16_t)rte_rand();
629 if (rte_fbk_hash_add_key(handle, key, val) == 0) {
633 if (added > (LOAD_FACTOR * ENTRIES))
637 for (i = 0; i < TEST_ITERATIONS; i++) {
641 /* Generate random indexes into keys[] array. */
642 for (j = 0; j < TEST_SIZE; j++)
643 indexes[j] = rte_rand() % added;
647 for (j = 0; j < TEST_SIZE; j++)
648 value += rte_fbk_hash_lookup(handle, keys[indexes[j]]);
651 lookup_time += (double)(end - begin);
654 printf("\n\n *** FBK Hash function performance test results ***\n");
656 * The use of the 'value' variable ensures that the hash lookup is not
657 * being optimised out by the compiler.
660 printf("Number of ticks per lookup = %g\n",
661 (double)lookup_time /
662 ((double)TEST_ITERATIONS * (double)TEST_SIZE));
664 rte_fbk_hash_free(handle);
672 unsigned int with_pushes, with_locks;
673 for (with_locks = 0; with_locks <= 1; with_locks++) {
675 printf("\nWith locks in the code\n");
677 printf("\nWithout locks in the code\n");
678 for (with_pushes = 0; with_pushes <= 1; with_pushes++) {
679 if (with_pushes == 0)
680 printf("\nALL ELEMENTS IN PRIMARY LOCATION\n");
682 printf("\nELEMENTS IN PRIMARY OR SECONDARY LOCATION\n");
683 if (run_all_tbl_perf_tests(with_pushes, with_locks, 0) < 0)
688 printf("\n EXTENDABLE BUCKETS PERFORMANCE\n");
690 if (run_all_tbl_perf_tests(1, 0, 1) < 0)
693 if (fbk_hash_perf_test() < 0)
699 REGISTER_TEST_COMMAND(hash_perf_autotest, test_hash_perf);