1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016-2017 Intel Corporation
8 #include <rte_malloc.h>
9 #include <rte_random.h>
11 #include <rte_cryptodev.h>
12 #ifdef RTE_LIBRTE_PMD_CRYPTO_SCHEDULER
13 #include <rte_cryptodev_scheduler.h>
17 #include "cperf_options.h"
18 #include "cperf_test_vector_parsing.h"
19 #include "cperf_test_throughput.h"
20 #include "cperf_test_latency.h"
21 #include "cperf_test_verify.h"
22 #include "cperf_test_pmd_cyclecount.h"
25 struct rte_mempool *sess_mp;
26 struct rte_mempool *priv_mp;
27 } session_pool_socket[RTE_MAX_NUMA_NODES];
29 const char *cperf_test_type_strs[] = {
30 [CPERF_TEST_TYPE_THROUGHPUT] = "throughput",
31 [CPERF_TEST_TYPE_LATENCY] = "latency",
32 [CPERF_TEST_TYPE_VERIFY] = "verify",
33 [CPERF_TEST_TYPE_PMDCC] = "pmd-cyclecount"
36 const char *cperf_op_type_strs[] = {
37 [CPERF_CIPHER_ONLY] = "cipher-only",
38 [CPERF_AUTH_ONLY] = "auth-only",
39 [CPERF_CIPHER_THEN_AUTH] = "cipher-then-auth",
40 [CPERF_AUTH_THEN_CIPHER] = "auth-then-cipher",
41 [CPERF_AEAD] = "aead",
42 [CPERF_PDCP] = "pdcp",
43 [CPERF_DOCSIS] = "docsis"
46 const struct cperf_test cperf_testmap[] = {
47 [CPERF_TEST_TYPE_THROUGHPUT] = {
48 cperf_throughput_test_constructor,
49 cperf_throughput_test_runner,
50 cperf_throughput_test_destructor
52 [CPERF_TEST_TYPE_LATENCY] = {
53 cperf_latency_test_constructor,
54 cperf_latency_test_runner,
55 cperf_latency_test_destructor
57 [CPERF_TEST_TYPE_VERIFY] = {
58 cperf_verify_test_constructor,
59 cperf_verify_test_runner,
60 cperf_verify_test_destructor
62 [CPERF_TEST_TYPE_PMDCC] = {
63 cperf_pmd_cyclecount_test_constructor,
64 cperf_pmd_cyclecount_test_runner,
65 cperf_pmd_cyclecount_test_destructor
70 fill_session_pool_socket(int32_t socket_id, uint32_t session_priv_size,
73 char mp_name[RTE_MEMPOOL_NAMESIZE];
74 struct rte_mempool *sess_mp;
76 if (session_pool_socket[socket_id].priv_mp == NULL) {
77 snprintf(mp_name, RTE_MEMPOOL_NAMESIZE,
78 "priv_sess_mp_%u", socket_id);
80 sess_mp = rte_mempool_create(mp_name,
83 0, 0, NULL, NULL, NULL,
87 if (sess_mp == NULL) {
88 printf("Cannot create pool \"%s\" on socket %d\n",
93 printf("Allocated pool \"%s\" on socket %d\n",
95 session_pool_socket[socket_id].priv_mp = sess_mp;
98 if (session_pool_socket[socket_id].sess_mp == NULL) {
100 snprintf(mp_name, RTE_MEMPOOL_NAMESIZE,
101 "sess_mp_%u", socket_id);
103 sess_mp = rte_cryptodev_sym_session_pool_create(mp_name,
104 nb_sessions, 0, 0, 0, socket_id);
106 if (sess_mp == NULL) {
107 printf("Cannot create pool \"%s\" on socket %d\n",
112 printf("Allocated pool \"%s\" on socket %d\n",
114 session_pool_socket[socket_id].sess_mp = sess_mp;
121 cperf_initialize_cryptodev(struct cperf_options *opts, uint8_t *enabled_cdevs)
123 uint8_t enabled_cdev_count = 0, nb_lcores, cdev_id;
124 uint32_t sessions_needed = 0;
128 enabled_cdev_count = rte_cryptodev_devices_get(opts->device_type,
129 enabled_cdevs, RTE_CRYPTO_MAX_DEVS);
130 if (enabled_cdev_count == 0) {
131 printf("No crypto devices type %s available\n",
136 nb_lcores = rte_lcore_count() - 1;
140 "Number of enabled cores need to be higher than 1\n");
145 * Use less number of devices,
146 * if there are more available than cores.
148 if (enabled_cdev_count > nb_lcores)
149 enabled_cdev_count = nb_lcores;
151 /* Create a mempool shared by all the devices */
152 uint32_t max_sess_size = 0, sess_size;
154 for (cdev_id = 0; cdev_id < rte_cryptodev_count(); cdev_id++) {
155 sess_size = rte_cryptodev_sym_get_private_session_size(cdev_id);
156 if (sess_size > max_sess_size)
157 max_sess_size = sess_size;
161 * Calculate number of needed queue pairs, based on the amount
162 * of available number of logical cores and crypto devices.
163 * For instance, if there are 4 cores and 2 crypto devices,
164 * 2 queue pairs will be set up per device.
166 opts->nb_qps = (nb_lcores % enabled_cdev_count) ?
167 (nb_lcores / enabled_cdev_count) + 1 :
168 nb_lcores / enabled_cdev_count;
170 for (i = 0; i < enabled_cdev_count &&
171 i < RTE_CRYPTO_MAX_DEVS; i++) {
172 cdev_id = enabled_cdevs[i];
173 #ifdef RTE_LIBRTE_PMD_CRYPTO_SCHEDULER
175 * If multi-core scheduler is used, limit the number
176 * of queue pairs to 1, as there is no way to know
177 * how many cores are being used by the PMD, and
178 * how many will be available for the application.
180 if (!strcmp((const char *)opts->device_type, "crypto_scheduler") &&
181 rte_cryptodev_scheduler_mode_get(cdev_id) ==
182 CDEV_SCHED_MODE_MULTICORE)
186 struct rte_cryptodev_info cdev_info;
187 uint8_t socket_id = rte_cryptodev_socket_id(cdev_id);
188 /* range check the socket_id - negative values become big
189 * positive ones due to use of unsigned value
191 if (socket_id >= RTE_MAX_NUMA_NODES)
194 rte_cryptodev_info_get(cdev_id, &cdev_info);
195 if (opts->nb_qps > cdev_info.max_nb_queue_pairs) {
196 printf("Number of needed queue pairs is higher "
197 "than the maximum number of queue pairs "
199 printf("Lower the number of cores or increase "
200 "the number of crypto devices\n");
203 struct rte_cryptodev_config conf = {
204 .nb_queue_pairs = opts->nb_qps,
205 .socket_id = socket_id,
206 .ff_disable = RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO,
209 if (opts->op_type != CPERF_PDCP &&
210 opts->op_type != CPERF_DOCSIS)
211 conf.ff_disable |= RTE_CRYPTODEV_FF_SECURITY;
213 struct rte_cryptodev_qp_conf qp_conf = {
214 .nb_descriptors = opts->nb_descriptors
218 * Device info specifies the min headroom and tailroom
219 * requirement for the crypto PMD. This need to be honoured
220 * by the application, while creating mbuf.
222 if (opts->headroom_sz < cdev_info.min_mbuf_headroom_req) {
223 /* Update headroom */
224 opts->headroom_sz = cdev_info.min_mbuf_headroom_req;
226 if (opts->tailroom_sz < cdev_info.min_mbuf_tailroom_req) {
227 /* Update tailroom */
228 opts->tailroom_sz = cdev_info.min_mbuf_tailroom_req;
231 /* Update segment size to include headroom & tailroom */
232 opts->segment_sz += (opts->headroom_sz + opts->tailroom_sz);
234 uint32_t dev_max_nb_sess = cdev_info.sym.max_nb_sessions;
236 * Two sessions objects are required for each session
237 * (one for the header, one for the private data)
239 if (!strcmp((const char *)opts->device_type,
240 "crypto_scheduler")) {
241 #ifdef RTE_LIBRTE_PMD_CRYPTO_SCHEDULER
243 rte_cryptodev_scheduler_slaves_get(cdev_id,
246 sessions_needed = enabled_cdev_count *
247 opts->nb_qps * nb_slaves;
250 sessions_needed = enabled_cdev_count *
254 * A single session is required per queue pair
257 if (dev_max_nb_sess != 0 && dev_max_nb_sess < opts->nb_qps) {
259 "Device does not support at least "
260 "%u sessions\n", opts->nb_qps);
264 ret = fill_session_pool_socket(socket_id, max_sess_size,
269 qp_conf.mp_session = session_pool_socket[socket_id].sess_mp;
270 qp_conf.mp_session_private =
271 session_pool_socket[socket_id].priv_mp;
273 ret = rte_cryptodev_configure(cdev_id, &conf);
275 printf("Failed to configure cryptodev %u", cdev_id);
279 for (j = 0; j < opts->nb_qps; j++) {
280 ret = rte_cryptodev_queue_pair_setup(cdev_id, j,
281 &qp_conf, socket_id);
283 printf("Failed to setup queue pair %u on "
284 "cryptodev %u", j, cdev_id);
289 ret = rte_cryptodev_start(cdev_id);
291 printf("Failed to start device %u: error %d\n",
297 return enabled_cdev_count;
301 cperf_verify_devices_capabilities(struct cperf_options *opts,
302 uint8_t *enabled_cdevs, uint8_t nb_cryptodevs)
304 struct rte_cryptodev_sym_capability_idx cap_idx;
305 const struct rte_cryptodev_symmetric_capability *capability;
310 for (i = 0; i < nb_cryptodevs; i++) {
312 cdev_id = enabled_cdevs[i];
314 if (opts->op_type == CPERF_AUTH_ONLY ||
315 opts->op_type == CPERF_CIPHER_THEN_AUTH ||
316 opts->op_type == CPERF_AUTH_THEN_CIPHER) {
318 cap_idx.type = RTE_CRYPTO_SYM_XFORM_AUTH;
319 cap_idx.algo.auth = opts->auth_algo;
321 capability = rte_cryptodev_sym_capability_get(cdev_id,
323 if (capability == NULL)
326 ret = rte_cryptodev_sym_capability_check_auth(
335 if (opts->op_type == CPERF_CIPHER_ONLY ||
336 opts->op_type == CPERF_CIPHER_THEN_AUTH ||
337 opts->op_type == CPERF_AUTH_THEN_CIPHER) {
339 cap_idx.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
340 cap_idx.algo.cipher = opts->cipher_algo;
342 capability = rte_cryptodev_sym_capability_get(cdev_id,
344 if (capability == NULL)
347 ret = rte_cryptodev_sym_capability_check_cipher(
355 if (opts->op_type == CPERF_AEAD) {
357 cap_idx.type = RTE_CRYPTO_SYM_XFORM_AEAD;
358 cap_idx.algo.aead = opts->aead_algo;
360 capability = rte_cryptodev_sym_capability_get(cdev_id,
362 if (capability == NULL)
365 ret = rte_cryptodev_sym_capability_check_aead(
380 cperf_check_test_vector(struct cperf_options *opts,
381 struct cperf_test_vector *test_vec)
383 if (opts->op_type == CPERF_CIPHER_ONLY) {
384 if (opts->cipher_algo == RTE_CRYPTO_CIPHER_NULL) {
385 if (test_vec->plaintext.data == NULL)
387 } else if (opts->cipher_algo != RTE_CRYPTO_CIPHER_NULL) {
388 if (test_vec->plaintext.data == NULL)
390 if (test_vec->plaintext.length < opts->max_buffer_size)
392 if (test_vec->ciphertext.data == NULL)
394 if (test_vec->ciphertext.length < opts->max_buffer_size)
396 /* Cipher IV is only required for some algorithms */
397 if (opts->cipher_iv_sz &&
398 test_vec->cipher_iv.data == NULL)
400 if (test_vec->cipher_iv.length != opts->cipher_iv_sz)
402 if (test_vec->cipher_key.data == NULL)
404 if (test_vec->cipher_key.length != opts->cipher_key_sz)
407 } else if (opts->op_type == CPERF_AUTH_ONLY) {
408 if (opts->auth_algo != RTE_CRYPTO_AUTH_NULL) {
409 if (test_vec->plaintext.data == NULL)
411 if (test_vec->plaintext.length < opts->max_buffer_size)
413 /* Auth key is only required for some algorithms */
414 if (opts->auth_key_sz &&
415 test_vec->auth_key.data == NULL)
417 if (test_vec->auth_key.length != opts->auth_key_sz)
419 if (test_vec->auth_iv.length != opts->auth_iv_sz)
421 /* Auth IV is only required for some algorithms */
422 if (opts->auth_iv_sz && test_vec->auth_iv.data == NULL)
424 if (test_vec->digest.data == NULL)
426 if (test_vec->digest.length < opts->digest_sz)
430 } else if (opts->op_type == CPERF_CIPHER_THEN_AUTH ||
431 opts->op_type == CPERF_AUTH_THEN_CIPHER) {
432 if (opts->cipher_algo == RTE_CRYPTO_CIPHER_NULL) {
433 if (test_vec->plaintext.data == NULL)
435 if (test_vec->plaintext.length < opts->max_buffer_size)
437 } else if (opts->cipher_algo != RTE_CRYPTO_CIPHER_NULL) {
438 if (test_vec->plaintext.data == NULL)
440 if (test_vec->plaintext.length < opts->max_buffer_size)
442 if (test_vec->ciphertext.data == NULL)
444 if (test_vec->ciphertext.length < opts->max_buffer_size)
446 if (test_vec->cipher_iv.data == NULL)
448 if (test_vec->cipher_iv.length != opts->cipher_iv_sz)
450 if (test_vec->cipher_key.data == NULL)
452 if (test_vec->cipher_key.length != opts->cipher_key_sz)
455 if (opts->auth_algo != RTE_CRYPTO_AUTH_NULL) {
456 if (test_vec->auth_key.data == NULL)
458 if (test_vec->auth_key.length != opts->auth_key_sz)
460 if (test_vec->auth_iv.length != opts->auth_iv_sz)
462 /* Auth IV is only required for some algorithms */
463 if (opts->auth_iv_sz && test_vec->auth_iv.data == NULL)
465 if (test_vec->digest.data == NULL)
467 if (test_vec->digest.length < opts->digest_sz)
470 } else if (opts->op_type == CPERF_AEAD) {
471 if (test_vec->plaintext.data == NULL)
473 if (test_vec->plaintext.length < opts->max_buffer_size)
475 if (test_vec->ciphertext.data == NULL)
477 if (test_vec->ciphertext.length < opts->max_buffer_size)
479 if (test_vec->aead_key.data == NULL)
481 if (test_vec->aead_key.length != opts->aead_key_sz)
483 if (test_vec->aead_iv.data == NULL)
485 if (test_vec->aead_iv.length != opts->aead_iv_sz)
487 if (test_vec->aad.data == NULL)
489 if (test_vec->aad.length != opts->aead_aad_sz)
491 if (test_vec->digest.data == NULL)
493 if (test_vec->digest.length < opts->digest_sz)
500 main(int argc, char **argv)
502 struct cperf_options opts = {0};
503 struct cperf_test_vector *t_vec = NULL;
504 struct cperf_op_fns op_fns;
505 void *ctx[RTE_MAX_LCORE] = { };
506 int nb_cryptodevs = 0;
507 uint16_t total_nb_qps = 0;
509 uint8_t enabled_cdevs[RTE_CRYPTO_MAX_DEVS] = { 0 };
511 uint8_t buffer_size_idx = 0;
516 /* Initialise DPDK EAL */
517 ret = rte_eal_init(argc, argv);
519 rte_exit(EXIT_FAILURE, "Invalid EAL arguments!\n");
523 cperf_options_default(&opts);
525 ret = cperf_options_parse(&opts, argc, argv);
527 RTE_LOG(ERR, USER1, "Parsing on or more user options failed\n");
531 ret = cperf_options_check(&opts);
534 "Checking on or more user options failed\n");
538 nb_cryptodevs = cperf_initialize_cryptodev(&opts, enabled_cdevs);
541 cperf_options_dump(&opts);
543 if (nb_cryptodevs < 1) {
544 RTE_LOG(ERR, USER1, "Failed to initialise requested crypto "
550 ret = cperf_verify_devices_capabilities(&opts, enabled_cdevs,
553 RTE_LOG(ERR, USER1, "Crypto device type does not support "
554 "capabilities requested\n");
558 if (opts.test_file != NULL) {
559 t_vec = cperf_test_vector_get_from_file(&opts);
562 "Failed to create test vector for"
563 " specified file\n");
567 if (cperf_check_test_vector(&opts, t_vec)) {
568 RTE_LOG(ERR, USER1, "Incomplete necessary test vectors"
573 t_vec = cperf_test_vector_get_dummy(&opts);
576 "Failed to create test vector for"
577 " specified algorithms\n");
582 ret = cperf_get_op_functions(&opts, &op_fns);
584 RTE_LOG(ERR, USER1, "Failed to find function ops set for "
585 "specified algorithms combination\n");
589 if (!opts.silent && opts.test != CPERF_TEST_TYPE_THROUGHPUT &&
590 opts.test != CPERF_TEST_TYPE_LATENCY)
591 show_test_vector(t_vec);
593 total_nb_qps = nb_cryptodevs * opts.nb_qps;
596 uint8_t qp_id = 0, cdev_index = 0;
597 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
599 if (i == total_nb_qps)
602 cdev_id = enabled_cdevs[cdev_index];
604 uint8_t socket_id = rte_cryptodev_socket_id(cdev_id);
606 ctx[i] = cperf_testmap[opts.test].constructor(
607 session_pool_socket[socket_id].sess_mp,
608 session_pool_socket[socket_id].priv_mp,
610 &opts, t_vec, &op_fns);
611 if (ctx[i] == NULL) {
612 RTE_LOG(ERR, USER1, "Test run constructor failed\n");
615 qp_id = (qp_id + 1) % opts.nb_qps;
621 if (opts.imix_distribution_count != 0) {
622 uint8_t buffer_size_count = opts.buffer_size_count;
623 uint16_t distribution_total[buffer_size_count];
625 uint32_t test_average_size = 0;
626 const uint32_t *buffer_size_list = opts.buffer_size_list;
627 const uint32_t *imix_distribution_list = opts.imix_distribution_list;
629 opts.imix_buffer_sizes = rte_malloc(NULL,
630 sizeof(uint32_t) * opts.pool_sz,
633 * Calculate accumulated distribution of
634 * probabilities per packet size
636 distribution_total[0] = imix_distribution_list[0];
637 for (i = 1; i < buffer_size_count; i++)
638 distribution_total[i] = imix_distribution_list[i] +
639 distribution_total[i-1];
641 /* Calculate a random sequence of packet sizes, based on distribution */
642 for (op_idx = 0; op_idx < opts.pool_sz; op_idx++) {
643 uint16_t random_number = rte_rand() %
644 distribution_total[buffer_size_count - 1];
645 for (i = 0; i < buffer_size_count; i++)
646 if (random_number < distribution_total[i])
649 opts.imix_buffer_sizes[op_idx] = buffer_size_list[i];
652 /* Calculate average buffer size for the IMIX distribution */
653 for (i = 0; i < buffer_size_count; i++)
654 test_average_size += buffer_size_list[i] *
655 imix_distribution_list[i];
657 opts.test_buffer_size = test_average_size /
658 distribution_total[buffer_size_count - 1];
661 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
663 if (i == total_nb_qps)
666 rte_eal_remote_launch(cperf_testmap[opts.test].runner,
671 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
673 if (i == total_nb_qps)
675 ret |= rte_eal_wait_lcore(lcore_id);
679 if (ret != EXIT_SUCCESS)
683 /* Get next size from range or list */
684 if (opts.inc_buffer_size != 0)
685 opts.test_buffer_size = opts.min_buffer_size;
687 opts.test_buffer_size = opts.buffer_size_list[0];
689 while (opts.test_buffer_size <= opts.max_buffer_size) {
691 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
693 if (i == total_nb_qps)
696 rte_eal_remote_launch(cperf_testmap[opts.test].runner,
701 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
703 if (i == total_nb_qps)
705 ret |= rte_eal_wait_lcore(lcore_id);
709 if (ret != EXIT_SUCCESS)
712 /* Get next size from range or list */
713 if (opts.inc_buffer_size != 0)
714 opts.test_buffer_size += opts.inc_buffer_size;
716 if (++buffer_size_idx == opts.buffer_size_count)
718 opts.test_buffer_size =
719 opts.buffer_size_list[buffer_size_idx];
725 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
727 if (i == total_nb_qps)
730 cperf_testmap[opts.test].destructor(ctx[i]);
734 for (i = 0; i < nb_cryptodevs &&
735 i < RTE_CRYPTO_MAX_DEVS; i++)
736 rte_cryptodev_stop(enabled_cdevs[i]);
738 free_test_vector(t_vec, &opts);
745 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
746 if (i == total_nb_qps)
749 if (ctx[i] && cperf_testmap[opts.test].destructor)
750 cperf_testmap[opts.test].destructor(ctx[i]);
754 for (i = 0; i < nb_cryptodevs &&
755 i < RTE_CRYPTO_MAX_DEVS; i++)
756 rte_cryptodev_stop(enabled_cdevs[i]);
757 rte_free(opts.imix_buffer_sizes);
758 free_test_vector(t_vec, &opts);