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",
44 const struct cperf_test cperf_testmap[] = {
45 [CPERF_TEST_TYPE_THROUGHPUT] = {
46 cperf_throughput_test_constructor,
47 cperf_throughput_test_runner,
48 cperf_throughput_test_destructor
50 [CPERF_TEST_TYPE_LATENCY] = {
51 cperf_latency_test_constructor,
52 cperf_latency_test_runner,
53 cperf_latency_test_destructor
55 [CPERF_TEST_TYPE_VERIFY] = {
56 cperf_verify_test_constructor,
57 cperf_verify_test_runner,
58 cperf_verify_test_destructor
60 [CPERF_TEST_TYPE_PMDCC] = {
61 cperf_pmd_cyclecount_test_constructor,
62 cperf_pmd_cyclecount_test_runner,
63 cperf_pmd_cyclecount_test_destructor
68 fill_session_pool_socket(int32_t socket_id, uint32_t session_priv_size,
71 char mp_name[RTE_MEMPOOL_NAMESIZE];
72 struct rte_mempool *sess_mp;
74 if (session_pool_socket[socket_id].priv_mp == NULL) {
75 snprintf(mp_name, RTE_MEMPOOL_NAMESIZE,
76 "priv_sess_mp_%u", socket_id);
78 sess_mp = rte_mempool_create(mp_name,
81 0, 0, NULL, NULL, NULL,
85 if (sess_mp == NULL) {
86 printf("Cannot create pool \"%s\" on socket %d\n",
91 printf("Allocated pool \"%s\" on socket %d\n",
93 session_pool_socket[socket_id].priv_mp = sess_mp;
96 if (session_pool_socket[socket_id].sess_mp == NULL) {
98 snprintf(mp_name, RTE_MEMPOOL_NAMESIZE,
99 "sess_mp_%u", socket_id);
101 sess_mp = rte_cryptodev_sym_session_pool_create(mp_name,
102 nb_sessions, 0, 0, 0, socket_id);
104 if (sess_mp == NULL) {
105 printf("Cannot create pool \"%s\" on socket %d\n",
110 printf("Allocated pool \"%s\" on socket %d\n",
112 session_pool_socket[socket_id].sess_mp = sess_mp;
119 cperf_initialize_cryptodev(struct cperf_options *opts, uint8_t *enabled_cdevs)
121 uint8_t enabled_cdev_count = 0, nb_lcores, cdev_id;
122 uint32_t sessions_needed = 0;
126 enabled_cdev_count = rte_cryptodev_devices_get(opts->device_type,
127 enabled_cdevs, RTE_CRYPTO_MAX_DEVS);
128 if (enabled_cdev_count == 0) {
129 printf("No crypto devices type %s available\n",
134 nb_lcores = rte_lcore_count() - 1;
138 "Number of enabled cores need to be higher than 1\n");
143 * Use less number of devices,
144 * if there are more available than cores.
146 if (enabled_cdev_count > nb_lcores)
147 enabled_cdev_count = nb_lcores;
149 /* Create a mempool shared by all the devices */
150 uint32_t max_sess_size = 0, sess_size;
152 for (cdev_id = 0; cdev_id < rte_cryptodev_count(); cdev_id++) {
153 sess_size = rte_cryptodev_sym_get_private_session_size(cdev_id);
154 if (sess_size > max_sess_size)
155 max_sess_size = sess_size;
159 * Calculate number of needed queue pairs, based on the amount
160 * of available number of logical cores and crypto devices.
161 * For instance, if there are 4 cores and 2 crypto devices,
162 * 2 queue pairs will be set up per device.
164 opts->nb_qps = (nb_lcores % enabled_cdev_count) ?
165 (nb_lcores / enabled_cdev_count) + 1 :
166 nb_lcores / enabled_cdev_count;
168 for (i = 0; i < enabled_cdev_count &&
169 i < RTE_CRYPTO_MAX_DEVS; i++) {
170 cdev_id = enabled_cdevs[i];
171 #ifdef RTE_LIBRTE_PMD_CRYPTO_SCHEDULER
173 * If multi-core scheduler is used, limit the number
174 * of queue pairs to 1, as there is no way to know
175 * how many cores are being used by the PMD, and
176 * how many will be available for the application.
178 if (!strcmp((const char *)opts->device_type, "crypto_scheduler") &&
179 rte_cryptodev_scheduler_mode_get(cdev_id) ==
180 CDEV_SCHED_MODE_MULTICORE)
184 struct rte_cryptodev_info cdev_info;
185 uint8_t socket_id = rte_cryptodev_socket_id(cdev_id);
186 /* range check the socket_id - negative values become big
187 * positive ones due to use of unsigned value
189 if (socket_id >= RTE_MAX_NUMA_NODES)
192 rte_cryptodev_info_get(cdev_id, &cdev_info);
193 if (opts->nb_qps > cdev_info.max_nb_queue_pairs) {
194 printf("Number of needed queue pairs is higher "
195 "than the maximum number of queue pairs "
197 printf("Lower the number of cores or increase "
198 "the number of crypto devices\n");
201 struct rte_cryptodev_config conf = {
202 .nb_queue_pairs = opts->nb_qps,
203 .socket_id = socket_id,
204 .ff_disable = RTE_CRYPTODEV_FF_SECURITY,
207 struct rte_cryptodev_qp_conf qp_conf = {
208 .nb_descriptors = opts->nb_descriptors
212 * Device info specifies the min headroom and tailroom
213 * requirement for the crypto PMD. This need to be honoured
214 * by the application, while creating mbuf.
216 if (opts->headroom_sz < cdev_info.min_mbuf_headroom_req) {
217 /* Update headroom */
218 opts->headroom_sz = cdev_info.min_mbuf_headroom_req;
220 if (opts->tailroom_sz < cdev_info.min_mbuf_tailroom_req) {
221 /* Update tailroom */
222 opts->tailroom_sz = cdev_info.min_mbuf_tailroom_req;
225 /* Update segment size to include headroom & tailroom */
226 opts->segment_sz += (opts->headroom_sz + opts->tailroom_sz);
228 uint32_t dev_max_nb_sess = cdev_info.sym.max_nb_sessions;
230 * Two sessions objects are required for each session
231 * (one for the header, one for the private data)
233 if (!strcmp((const char *)opts->device_type,
234 "crypto_scheduler")) {
235 #ifdef RTE_LIBRTE_PMD_CRYPTO_SCHEDULER
237 rte_cryptodev_scheduler_slaves_get(cdev_id,
240 sessions_needed = enabled_cdev_count *
241 opts->nb_qps * nb_slaves;
244 sessions_needed = enabled_cdev_count *
248 * A single session is required per queue pair
251 if (dev_max_nb_sess != 0 && dev_max_nb_sess < opts->nb_qps) {
253 "Device does not support at least "
254 "%u sessions\n", opts->nb_qps);
258 ret = fill_session_pool_socket(socket_id, max_sess_size,
263 qp_conf.mp_session = session_pool_socket[socket_id].sess_mp;
264 qp_conf.mp_session_private =
265 session_pool_socket[socket_id].priv_mp;
267 ret = rte_cryptodev_configure(cdev_id, &conf);
269 printf("Failed to configure cryptodev %u", cdev_id);
273 for (j = 0; j < opts->nb_qps; j++) {
274 ret = rte_cryptodev_queue_pair_setup(cdev_id, j,
275 &qp_conf, socket_id);
277 printf("Failed to setup queue pair %u on "
278 "cryptodev %u", j, cdev_id);
283 ret = rte_cryptodev_start(cdev_id);
285 printf("Failed to start device %u: error %d\n",
291 return enabled_cdev_count;
295 cperf_verify_devices_capabilities(struct cperf_options *opts,
296 uint8_t *enabled_cdevs, uint8_t nb_cryptodevs)
298 struct rte_cryptodev_sym_capability_idx cap_idx;
299 const struct rte_cryptodev_symmetric_capability *capability;
304 for (i = 0; i < nb_cryptodevs; i++) {
306 cdev_id = enabled_cdevs[i];
308 if (opts->op_type == CPERF_AUTH_ONLY ||
309 opts->op_type == CPERF_CIPHER_THEN_AUTH ||
310 opts->op_type == CPERF_AUTH_THEN_CIPHER) {
312 cap_idx.type = RTE_CRYPTO_SYM_XFORM_AUTH;
313 cap_idx.algo.auth = opts->auth_algo;
315 capability = rte_cryptodev_sym_capability_get(cdev_id,
317 if (capability == NULL)
320 ret = rte_cryptodev_sym_capability_check_auth(
329 if (opts->op_type == CPERF_CIPHER_ONLY ||
330 opts->op_type == CPERF_CIPHER_THEN_AUTH ||
331 opts->op_type == CPERF_AUTH_THEN_CIPHER) {
333 cap_idx.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
334 cap_idx.algo.cipher = opts->cipher_algo;
336 capability = rte_cryptodev_sym_capability_get(cdev_id,
338 if (capability == NULL)
341 ret = rte_cryptodev_sym_capability_check_cipher(
349 if (opts->op_type == CPERF_AEAD) {
351 cap_idx.type = RTE_CRYPTO_SYM_XFORM_AEAD;
352 cap_idx.algo.aead = opts->aead_algo;
354 capability = rte_cryptodev_sym_capability_get(cdev_id,
356 if (capability == NULL)
359 ret = rte_cryptodev_sym_capability_check_aead(
374 cperf_check_test_vector(struct cperf_options *opts,
375 struct cperf_test_vector *test_vec)
377 if (opts->op_type == CPERF_CIPHER_ONLY) {
378 if (opts->cipher_algo == RTE_CRYPTO_CIPHER_NULL) {
379 if (test_vec->plaintext.data == NULL)
381 } else if (opts->cipher_algo != RTE_CRYPTO_CIPHER_NULL) {
382 if (test_vec->plaintext.data == NULL)
384 if (test_vec->plaintext.length < opts->max_buffer_size)
386 if (test_vec->ciphertext.data == NULL)
388 if (test_vec->ciphertext.length < opts->max_buffer_size)
390 /* Cipher IV is only required for some algorithms */
391 if (opts->cipher_iv_sz &&
392 test_vec->cipher_iv.data == NULL)
394 if (test_vec->cipher_iv.length != opts->cipher_iv_sz)
396 if (test_vec->cipher_key.data == NULL)
398 if (test_vec->cipher_key.length != opts->cipher_key_sz)
401 } else if (opts->op_type == CPERF_AUTH_ONLY) {
402 if (opts->auth_algo != RTE_CRYPTO_AUTH_NULL) {
403 if (test_vec->plaintext.data == NULL)
405 if (test_vec->plaintext.length < opts->max_buffer_size)
407 /* Auth key is only required for some algorithms */
408 if (opts->auth_key_sz &&
409 test_vec->auth_key.data == NULL)
411 if (test_vec->auth_key.length != opts->auth_key_sz)
413 if (test_vec->auth_iv.length != opts->auth_iv_sz)
415 /* Auth IV is only required for some algorithms */
416 if (opts->auth_iv_sz && test_vec->auth_iv.data == NULL)
418 if (test_vec->digest.data == NULL)
420 if (test_vec->digest.length < opts->digest_sz)
424 } else if (opts->op_type == CPERF_CIPHER_THEN_AUTH ||
425 opts->op_type == CPERF_AUTH_THEN_CIPHER) {
426 if (opts->cipher_algo == RTE_CRYPTO_CIPHER_NULL) {
427 if (test_vec->plaintext.data == NULL)
429 if (test_vec->plaintext.length < opts->max_buffer_size)
431 } else if (opts->cipher_algo != RTE_CRYPTO_CIPHER_NULL) {
432 if (test_vec->plaintext.data == NULL)
434 if (test_vec->plaintext.length < opts->max_buffer_size)
436 if (test_vec->ciphertext.data == NULL)
438 if (test_vec->ciphertext.length < opts->max_buffer_size)
440 if (test_vec->cipher_iv.data == NULL)
442 if (test_vec->cipher_iv.length != opts->cipher_iv_sz)
444 if (test_vec->cipher_key.data == NULL)
446 if (test_vec->cipher_key.length != opts->cipher_key_sz)
449 if (opts->auth_algo != RTE_CRYPTO_AUTH_NULL) {
450 if (test_vec->auth_key.data == NULL)
452 if (test_vec->auth_key.length != opts->auth_key_sz)
454 if (test_vec->auth_iv.length != opts->auth_iv_sz)
456 /* Auth IV is only required for some algorithms */
457 if (opts->auth_iv_sz && test_vec->auth_iv.data == NULL)
459 if (test_vec->digest.data == NULL)
461 if (test_vec->digest.length < opts->digest_sz)
464 } else if (opts->op_type == CPERF_AEAD) {
465 if (test_vec->plaintext.data == NULL)
467 if (test_vec->plaintext.length < opts->max_buffer_size)
469 if (test_vec->ciphertext.data == NULL)
471 if (test_vec->ciphertext.length < opts->max_buffer_size)
473 if (test_vec->aead_key.data == NULL)
475 if (test_vec->aead_key.length != opts->aead_key_sz)
477 if (test_vec->aead_iv.data == NULL)
479 if (test_vec->aead_iv.length != opts->aead_iv_sz)
481 if (test_vec->aad.data == NULL)
483 if (test_vec->aad.length != opts->aead_aad_sz)
485 if (test_vec->digest.data == NULL)
487 if (test_vec->digest.length < opts->digest_sz)
494 main(int argc, char **argv)
496 struct cperf_options opts = {0};
497 struct cperf_test_vector *t_vec = NULL;
498 struct cperf_op_fns op_fns;
499 void *ctx[RTE_MAX_LCORE] = { };
500 int nb_cryptodevs = 0;
501 uint16_t total_nb_qps = 0;
503 uint8_t enabled_cdevs[RTE_CRYPTO_MAX_DEVS] = { 0 };
505 uint8_t buffer_size_idx = 0;
510 /* Initialise DPDK EAL */
511 ret = rte_eal_init(argc, argv);
513 rte_exit(EXIT_FAILURE, "Invalid EAL arguments!\n");
517 cperf_options_default(&opts);
519 ret = cperf_options_parse(&opts, argc, argv);
521 RTE_LOG(ERR, USER1, "Parsing on or more user options failed\n");
525 ret = cperf_options_check(&opts);
528 "Checking on or more user options failed\n");
532 nb_cryptodevs = cperf_initialize_cryptodev(&opts, enabled_cdevs);
535 cperf_options_dump(&opts);
537 if (nb_cryptodevs < 1) {
538 RTE_LOG(ERR, USER1, "Failed to initialise requested crypto "
544 ret = cperf_verify_devices_capabilities(&opts, enabled_cdevs,
547 RTE_LOG(ERR, USER1, "Crypto device type does not support "
548 "capabilities requested\n");
552 if (opts.test_file != NULL) {
553 t_vec = cperf_test_vector_get_from_file(&opts);
556 "Failed to create test vector for"
557 " specified file\n");
561 if (cperf_check_test_vector(&opts, t_vec)) {
562 RTE_LOG(ERR, USER1, "Incomplete necessary test vectors"
567 t_vec = cperf_test_vector_get_dummy(&opts);
570 "Failed to create test vector for"
571 " specified algorithms\n");
576 ret = cperf_get_op_functions(&opts, &op_fns);
578 RTE_LOG(ERR, USER1, "Failed to find function ops set for "
579 "specified algorithms combination\n");
584 show_test_vector(t_vec);
586 total_nb_qps = nb_cryptodevs * opts.nb_qps;
589 uint8_t qp_id = 0, cdev_index = 0;
590 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
592 if (i == total_nb_qps)
595 cdev_id = enabled_cdevs[cdev_index];
597 uint8_t socket_id = rte_cryptodev_socket_id(cdev_id);
599 ctx[i] = cperf_testmap[opts.test].constructor(
600 session_pool_socket[socket_id].sess_mp,
601 session_pool_socket[socket_id].priv_mp,
603 &opts, t_vec, &op_fns);
604 if (ctx[i] == NULL) {
605 RTE_LOG(ERR, USER1, "Test run constructor failed\n");
608 qp_id = (qp_id + 1) % opts.nb_qps;
614 if (opts.imix_distribution_count != 0) {
615 uint8_t buffer_size_count = opts.buffer_size_count;
616 uint16_t distribution_total[buffer_size_count];
618 uint32_t test_average_size = 0;
619 const uint32_t *buffer_size_list = opts.buffer_size_list;
620 const uint32_t *imix_distribution_list = opts.imix_distribution_list;
622 opts.imix_buffer_sizes = rte_malloc(NULL,
623 sizeof(uint32_t) * opts.pool_sz,
626 * Calculate accumulated distribution of
627 * probabilities per packet size
629 distribution_total[0] = imix_distribution_list[0];
630 for (i = 1; i < buffer_size_count; i++)
631 distribution_total[i] = imix_distribution_list[i] +
632 distribution_total[i-1];
634 /* Calculate a random sequence of packet sizes, based on distribution */
635 for (op_idx = 0; op_idx < opts.pool_sz; op_idx++) {
636 uint16_t random_number = rte_rand() %
637 distribution_total[buffer_size_count - 1];
638 for (i = 0; i < buffer_size_count; i++)
639 if (random_number < distribution_total[i])
642 opts.imix_buffer_sizes[op_idx] = buffer_size_list[i];
645 /* Calculate average buffer size for the IMIX distribution */
646 for (i = 0; i < buffer_size_count; i++)
647 test_average_size += buffer_size_list[i] *
648 imix_distribution_list[i];
650 opts.test_buffer_size = test_average_size /
651 distribution_total[buffer_size_count - 1];
654 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
656 if (i == total_nb_qps)
659 rte_eal_remote_launch(cperf_testmap[opts.test].runner,
664 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
666 if (i == total_nb_qps)
668 ret |= rte_eal_wait_lcore(lcore_id);
672 if (ret != EXIT_SUCCESS)
676 /* Get next size from range or list */
677 if (opts.inc_buffer_size != 0)
678 opts.test_buffer_size = opts.min_buffer_size;
680 opts.test_buffer_size = opts.buffer_size_list[0];
682 while (opts.test_buffer_size <= opts.max_buffer_size) {
684 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
686 if (i == total_nb_qps)
689 rte_eal_remote_launch(cperf_testmap[opts.test].runner,
694 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
696 if (i == total_nb_qps)
698 ret |= rte_eal_wait_lcore(lcore_id);
702 if (ret != EXIT_SUCCESS)
705 /* Get next size from range or list */
706 if (opts.inc_buffer_size != 0)
707 opts.test_buffer_size += opts.inc_buffer_size;
709 if (++buffer_size_idx == opts.buffer_size_count)
711 opts.test_buffer_size =
712 opts.buffer_size_list[buffer_size_idx];
718 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
720 if (i == total_nb_qps)
723 cperf_testmap[opts.test].destructor(ctx[i]);
727 for (i = 0; i < nb_cryptodevs &&
728 i < RTE_CRYPTO_MAX_DEVS; i++)
729 rte_cryptodev_stop(enabled_cdevs[i]);
731 free_test_vector(t_vec, &opts);
738 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
739 if (i == total_nb_qps)
742 if (ctx[i] && cperf_testmap[opts.test].destructor)
743 cperf_testmap[opts.test].destructor(ctx[i]);
747 for (i = 0; i < nb_cryptodevs &&
748 i < RTE_CRYPTO_MAX_DEVS; i++)
749 rte_cryptodev_stop(enabled_cdevs[i]);
750 rte_free(opts.imix_buffer_sizes);
751 free_test_vector(t_vec, &opts);