4 * Copyright(c) 2016-2017 Intel Corporation. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
16 * * Neither the name of Intel Corporation nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 #include <rte_cryptodev.h>
40 #include "cperf_options.h"
41 #include "cperf_test_vector_parsing.h"
42 #include "cperf_test_throughput.h"
43 #include "cperf_test_latency.h"
44 #include "cperf_test_verify.h"
46 #define NUM_SESSIONS 2048
47 #define SESS_MEMPOOL_CACHE_SIZE 64
49 const char *cperf_test_type_strs[] = {
50 [CPERF_TEST_TYPE_THROUGHPUT] = "throughput",
51 [CPERF_TEST_TYPE_LATENCY] = "latency",
52 [CPERF_TEST_TYPE_VERIFY] = "verify"
55 const char *cperf_op_type_strs[] = {
56 [CPERF_CIPHER_ONLY] = "cipher-only",
57 [CPERF_AUTH_ONLY] = "auth-only",
58 [CPERF_CIPHER_THEN_AUTH] = "cipher-then-auth",
59 [CPERF_AUTH_THEN_CIPHER] = "auth-then-cipher",
63 const struct cperf_test cperf_testmap[] = {
64 [CPERF_TEST_TYPE_THROUGHPUT] = {
65 cperf_throughput_test_constructor,
66 cperf_throughput_test_runner,
67 cperf_throughput_test_destructor
69 [CPERF_TEST_TYPE_LATENCY] = {
70 cperf_latency_test_constructor,
71 cperf_latency_test_runner,
72 cperf_latency_test_destructor
74 [CPERF_TEST_TYPE_VERIFY] = {
75 cperf_verify_test_constructor,
76 cperf_verify_test_runner,
77 cperf_verify_test_destructor
82 cperf_initialize_cryptodev(struct cperf_options *opts, uint8_t *enabled_cdevs,
83 struct rte_mempool *session_pool_socket[])
85 uint8_t enabled_cdev_count = 0, nb_lcores, cdev_id;
89 enabled_cdev_count = rte_cryptodev_devices_get(opts->device_type,
90 enabled_cdevs, RTE_CRYPTO_MAX_DEVS);
91 if (enabled_cdev_count == 0) {
92 printf("No crypto devices type %s available\n",
97 nb_lcores = rte_lcore_count() - 1;
99 if (enabled_cdev_count > nb_lcores) {
100 printf("Number of capable crypto devices (%d) "
101 "has to be less or equal to number of slave "
102 "cores (%d)\n", enabled_cdev_count, nb_lcores);
106 /* Create a mempool shared by all the devices */
107 uint32_t max_sess_size = 0, sess_size;
109 for (cdev_id = 0; cdev_id < rte_cryptodev_count(); cdev_id++) {
110 sess_size = rte_cryptodev_get_private_session_size(cdev_id);
111 if (sess_size > max_sess_size)
112 max_sess_size = sess_size;
115 for (i = 0; i < enabled_cdev_count &&
116 i < RTE_CRYPTO_MAX_DEVS; i++) {
117 cdev_id = enabled_cdevs[i];
118 uint8_t socket_id = rte_cryptodev_socket_id(cdev_id);
120 struct rte_cryptodev_config conf = {
122 .socket_id = socket_id
125 struct rte_cryptodev_qp_conf qp_conf = {
126 .nb_descriptors = 2048
130 if (session_pool_socket[socket_id] == NULL) {
131 char mp_name[RTE_MEMPOOL_NAMESIZE];
132 struct rte_mempool *sess_mp;
134 snprintf(mp_name, RTE_MEMPOOL_NAMESIZE,
135 "sess_mp_%u", socket_id);
137 sess_mp = rte_mempool_create(mp_name,
140 SESS_MEMPOOL_CACHE_SIZE,
145 if (sess_mp == NULL) {
146 printf("Cannot create session pool on socket %d\n",
151 printf("Allocated session pool on socket %d\n", socket_id);
152 session_pool_socket[socket_id] = sess_mp;
155 ret = rte_cryptodev_configure(cdev_id, &conf);
157 printf("Failed to configure cryptodev %u", cdev_id);
161 ret = rte_cryptodev_queue_pair_setup(cdev_id, 0,
163 session_pool_socket[socket_id]);
165 printf("Failed to setup queue pair %u on "
166 "cryptodev %u", 0, cdev_id);
170 ret = rte_cryptodev_start(cdev_id);
172 printf("Failed to start device %u: error %d\n",
178 return enabled_cdev_count;
182 cperf_verify_devices_capabilities(struct cperf_options *opts,
183 uint8_t *enabled_cdevs, uint8_t nb_cryptodevs)
185 struct rte_cryptodev_sym_capability_idx cap_idx;
186 const struct rte_cryptodev_symmetric_capability *capability;
191 for (i = 0; i < nb_cryptodevs; i++) {
193 cdev_id = enabled_cdevs[i];
195 if (opts->op_type == CPERF_AUTH_ONLY ||
196 opts->op_type == CPERF_CIPHER_THEN_AUTH ||
197 opts->op_type == CPERF_AUTH_THEN_CIPHER) {
199 cap_idx.type = RTE_CRYPTO_SYM_XFORM_AUTH;
200 cap_idx.algo.auth = opts->auth_algo;
202 capability = rte_cryptodev_sym_capability_get(cdev_id,
204 if (capability == NULL)
207 ret = rte_cryptodev_sym_capability_check_auth(
216 if (opts->op_type == CPERF_CIPHER_ONLY ||
217 opts->op_type == CPERF_CIPHER_THEN_AUTH ||
218 opts->op_type == CPERF_AUTH_THEN_CIPHER) {
220 cap_idx.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
221 cap_idx.algo.cipher = opts->cipher_algo;
223 capability = rte_cryptodev_sym_capability_get(cdev_id,
225 if (capability == NULL)
228 ret = rte_cryptodev_sym_capability_check_cipher(
236 if (opts->op_type == CPERF_AEAD) {
238 cap_idx.type = RTE_CRYPTO_SYM_XFORM_AEAD;
239 cap_idx.algo.aead = opts->aead_algo;
241 capability = rte_cryptodev_sym_capability_get(cdev_id,
243 if (capability == NULL)
246 ret = rte_cryptodev_sym_capability_check_aead(
261 cperf_check_test_vector(struct cperf_options *opts,
262 struct cperf_test_vector *test_vec)
264 if (opts->op_type == CPERF_CIPHER_ONLY) {
265 if (opts->cipher_algo == RTE_CRYPTO_CIPHER_NULL) {
266 if (test_vec->plaintext.data == NULL)
268 } else if (opts->cipher_algo != RTE_CRYPTO_CIPHER_NULL) {
269 if (test_vec->plaintext.data == NULL)
271 if (test_vec->plaintext.length < opts->max_buffer_size)
273 if (test_vec->ciphertext.data == NULL)
275 if (test_vec->ciphertext.length < opts->max_buffer_size)
277 if (test_vec->cipher_iv.data == NULL)
279 if (test_vec->cipher_iv.length != opts->cipher_iv_sz)
281 if (test_vec->cipher_key.data == NULL)
283 if (test_vec->cipher_key.length != opts->cipher_key_sz)
286 } else if (opts->op_type == CPERF_AUTH_ONLY) {
287 if (opts->auth_algo != RTE_CRYPTO_AUTH_NULL) {
288 if (test_vec->plaintext.data == NULL)
290 if (test_vec->plaintext.length < opts->max_buffer_size)
292 if (test_vec->auth_key.data == NULL)
294 if (test_vec->auth_key.length != opts->auth_key_sz)
296 if (test_vec->auth_iv.length != opts->auth_iv_sz)
298 /* Auth IV is only required for some algorithms */
299 if (opts->auth_iv_sz && test_vec->auth_iv.data == NULL)
301 if (test_vec->digest.data == NULL)
303 if (test_vec->digest.length < opts->digest_sz)
307 } else if (opts->op_type == CPERF_CIPHER_THEN_AUTH ||
308 opts->op_type == CPERF_AUTH_THEN_CIPHER) {
309 if (opts->cipher_algo == RTE_CRYPTO_CIPHER_NULL) {
310 if (test_vec->plaintext.data == NULL)
312 if (test_vec->plaintext.length < opts->max_buffer_size)
314 } else if (opts->cipher_algo != RTE_CRYPTO_CIPHER_NULL) {
315 if (test_vec->plaintext.data == NULL)
317 if (test_vec->plaintext.length < opts->max_buffer_size)
319 if (test_vec->ciphertext.data == NULL)
321 if (test_vec->ciphertext.length < opts->max_buffer_size)
323 if (test_vec->cipher_iv.data == NULL)
325 if (test_vec->cipher_iv.length != opts->cipher_iv_sz)
327 if (test_vec->cipher_key.data == NULL)
329 if (test_vec->cipher_key.length != opts->cipher_key_sz)
332 if (opts->auth_algo != RTE_CRYPTO_AUTH_NULL) {
333 if (test_vec->auth_key.data == NULL)
335 if (test_vec->auth_key.length != opts->auth_key_sz)
337 if (test_vec->auth_iv.length != opts->auth_iv_sz)
339 /* Auth IV is only required for some algorithms */
340 if (opts->auth_iv_sz && test_vec->auth_iv.data == NULL)
342 if (test_vec->digest.data == NULL)
344 if (test_vec->digest.length < opts->digest_sz)
347 } else if (opts->op_type == CPERF_AEAD) {
348 if (test_vec->plaintext.data == NULL)
350 if (test_vec->plaintext.length < opts->max_buffer_size)
352 if (test_vec->ciphertext.data == NULL)
354 if (test_vec->ciphertext.length < opts->max_buffer_size)
356 if (test_vec->aead_iv.data == NULL)
358 if (test_vec->aead_iv.length != opts->aead_iv_sz)
360 if (test_vec->aad.data == NULL)
362 if (test_vec->aad.length != opts->aead_aad_sz)
364 if (test_vec->digest.data == NULL)
366 if (test_vec->digest.length < opts->digest_sz)
373 main(int argc, char **argv)
375 struct cperf_options opts = {0};
376 struct cperf_test_vector *t_vec = NULL;
377 struct cperf_op_fns op_fns;
379 void *ctx[RTE_MAX_LCORE] = { };
380 struct rte_mempool *session_pool_socket[RTE_MAX_NUMA_NODES] = { 0 };
382 int nb_cryptodevs = 0;
384 uint8_t enabled_cdevs[RTE_CRYPTO_MAX_DEVS] = { 0 };
386 uint8_t buffer_size_idx = 0;
391 /* Initialise DPDK EAL */
392 ret = rte_eal_init(argc, argv);
394 rte_exit(EXIT_FAILURE, "Invalid EAL arguments!\n");
398 cperf_options_default(&opts);
400 ret = cperf_options_parse(&opts, argc, argv);
402 RTE_LOG(ERR, USER1, "Parsing on or more user options failed\n");
406 ret = cperf_options_check(&opts);
409 "Checking on or more user options failed\n");
414 cperf_options_dump(&opts);
416 nb_cryptodevs = cperf_initialize_cryptodev(&opts, enabled_cdevs,
417 session_pool_socket);
418 if (nb_cryptodevs < 1) {
419 RTE_LOG(ERR, USER1, "Failed to initialise requested crypto "
425 ret = cperf_verify_devices_capabilities(&opts, enabled_cdevs,
428 RTE_LOG(ERR, USER1, "Crypto device type does not support "
429 "capabilities requested\n");
433 if (opts.test_file != NULL) {
434 t_vec = cperf_test_vector_get_from_file(&opts);
437 "Failed to create test vector for"
438 " specified file\n");
442 if (cperf_check_test_vector(&opts, t_vec)) {
443 RTE_LOG(ERR, USER1, "Incomplete necessary test vectors"
448 t_vec = cperf_test_vector_get_dummy(&opts);
451 "Failed to create test vector for"
452 " specified algorithms\n");
457 ret = cperf_get_op_functions(&opts, &op_fns);
459 RTE_LOG(ERR, USER1, "Failed to find function ops set for "
460 "specified algorithms combination\n");
465 show_test_vector(t_vec);
468 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
470 if (i == nb_cryptodevs)
473 cdev_id = enabled_cdevs[i];
475 uint8_t socket_id = rte_cryptodev_socket_id(cdev_id);
477 ctx[cdev_id] = cperf_testmap[opts.test].constructor(
478 session_pool_socket[socket_id], cdev_id, 0,
479 &opts, t_vec, &op_fns);
480 if (ctx[cdev_id] == NULL) {
481 RTE_LOG(ERR, USER1, "Test run constructor failed\n");
487 /* Get first size from range or list */
488 if (opts.inc_buffer_size != 0)
489 opts.test_buffer_size = opts.min_buffer_size;
491 opts.test_buffer_size = opts.buffer_size_list[0];
493 while (opts.test_buffer_size <= opts.max_buffer_size) {
495 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
497 if (i == nb_cryptodevs)
500 cdev_id = enabled_cdevs[i];
502 rte_eal_remote_launch(cperf_testmap[opts.test].runner,
503 ctx[cdev_id], lcore_id);
507 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
509 if (i == nb_cryptodevs)
511 rte_eal_wait_lcore(lcore_id);
515 /* Get next size from range or list */
516 if (opts.inc_buffer_size != 0)
517 opts.test_buffer_size += opts.inc_buffer_size;
519 if (++buffer_size_idx == opts.buffer_size_count)
521 opts.test_buffer_size = opts.buffer_size_list[buffer_size_idx];
526 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
528 if (i == nb_cryptodevs)
531 cdev_id = enabled_cdevs[i];
533 cperf_testmap[opts.test].destructor(ctx[cdev_id]);
537 free_test_vector(t_vec, &opts);
544 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
545 if (i == nb_cryptodevs)
548 cdev_id = enabled_cdevs[i];
550 if (ctx[cdev_id] && cperf_testmap[opts.test].destructor)
551 cperf_testmap[opts.test].destructor(ctx[cdev_id]);
555 free_test_vector(t_vec, &opts);