1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2015-2017 Intel Corporation
15 #include <netinet/in.h>
17 #include <rte_byteorder.h>
19 #include <rte_debug.h>
21 #include <rte_interrupts.h>
22 #include <rte_memory.h>
23 #include <rte_memcpy.h>
24 #include <rte_memzone.h>
25 #include <rte_launch.h>
26 #include <rte_tailq.h>
28 #include <rte_per_lcore.h>
29 #include <rte_lcore.h>
30 #include <rte_atomic.h>
31 #include <rte_branch_prediction.h>
32 #include <rte_common.h>
33 #include <rte_mempool.h>
34 #include <rte_malloc.h>
36 #include <rte_errno.h>
37 #include <rte_spinlock.h>
38 #include <rte_string_fns.h>
40 #include "rte_crypto.h"
41 #include "rte_cryptodev.h"
42 #include "rte_cryptodev_pmd.h"
44 static uint8_t nb_drivers;
46 static struct rte_cryptodev rte_crypto_devices[RTE_CRYPTO_MAX_DEVS];
48 struct rte_cryptodev *rte_cryptodevs = rte_crypto_devices;
50 static struct rte_cryptodev_global cryptodev_globals = {
51 .devs = rte_crypto_devices,
54 .max_devs = RTE_CRYPTO_MAX_DEVS
57 /* spinlock for crypto device callbacks */
58 static rte_spinlock_t rte_cryptodev_cb_lock = RTE_SPINLOCK_INITIALIZER;
62 * The user application callback description.
64 * It contains callback address to be registered by user application,
65 * the pointer to the parameters for callback, and the event type.
67 struct rte_cryptodev_callback {
68 TAILQ_ENTRY(rte_cryptodev_callback) next; /**< Callbacks list */
69 rte_cryptodev_cb_fn cb_fn; /**< Callback address */
70 void *cb_arg; /**< Parameter for callback */
71 enum rte_cryptodev_event_type event; /**< Interrupt event type */
72 uint32_t active; /**< Callback is executing */
76 * The crypto cipher algorithm strings identifiers.
77 * It could be used in application command line.
80 rte_crypto_cipher_algorithm_strings[] = {
81 [RTE_CRYPTO_CIPHER_3DES_CBC] = "3des-cbc",
82 [RTE_CRYPTO_CIPHER_3DES_ECB] = "3des-ecb",
83 [RTE_CRYPTO_CIPHER_3DES_CTR] = "3des-ctr",
85 [RTE_CRYPTO_CIPHER_AES_CBC] = "aes-cbc",
86 [RTE_CRYPTO_CIPHER_AES_CTR] = "aes-ctr",
87 [RTE_CRYPTO_CIPHER_AES_DOCSISBPI] = "aes-docsisbpi",
88 [RTE_CRYPTO_CIPHER_AES_ECB] = "aes-ecb",
89 [RTE_CRYPTO_CIPHER_AES_F8] = "aes-f8",
90 [RTE_CRYPTO_CIPHER_AES_XTS] = "aes-xts",
92 [RTE_CRYPTO_CIPHER_ARC4] = "arc4",
94 [RTE_CRYPTO_CIPHER_DES_CBC] = "des-cbc",
95 [RTE_CRYPTO_CIPHER_DES_DOCSISBPI] = "des-docsisbpi",
97 [RTE_CRYPTO_CIPHER_NULL] = "null",
99 [RTE_CRYPTO_CIPHER_KASUMI_F8] = "kasumi-f8",
100 [RTE_CRYPTO_CIPHER_SNOW3G_UEA2] = "snow3g-uea2",
101 [RTE_CRYPTO_CIPHER_ZUC_EEA3] = "zuc-eea3"
105 * The crypto cipher operation strings identifiers.
106 * It could be used in application command line.
109 rte_crypto_cipher_operation_strings[] = {
110 [RTE_CRYPTO_CIPHER_OP_ENCRYPT] = "encrypt",
111 [RTE_CRYPTO_CIPHER_OP_DECRYPT] = "decrypt"
115 * The crypto auth algorithm strings identifiers.
116 * It could be used in application command line.
119 rte_crypto_auth_algorithm_strings[] = {
120 [RTE_CRYPTO_AUTH_AES_CBC_MAC] = "aes-cbc-mac",
121 [RTE_CRYPTO_AUTH_AES_CMAC] = "aes-cmac",
122 [RTE_CRYPTO_AUTH_AES_GMAC] = "aes-gmac",
123 [RTE_CRYPTO_AUTH_AES_XCBC_MAC] = "aes-xcbc-mac",
125 [RTE_CRYPTO_AUTH_MD5] = "md5",
126 [RTE_CRYPTO_AUTH_MD5_HMAC] = "md5-hmac",
128 [RTE_CRYPTO_AUTH_NULL] = "null",
130 [RTE_CRYPTO_AUTH_SHA1] = "sha1",
131 [RTE_CRYPTO_AUTH_SHA1_HMAC] = "sha1-hmac",
133 [RTE_CRYPTO_AUTH_SHA224] = "sha2-224",
134 [RTE_CRYPTO_AUTH_SHA224_HMAC] = "sha2-224-hmac",
135 [RTE_CRYPTO_AUTH_SHA256] = "sha2-256",
136 [RTE_CRYPTO_AUTH_SHA256_HMAC] = "sha2-256-hmac",
137 [RTE_CRYPTO_AUTH_SHA384] = "sha2-384",
138 [RTE_CRYPTO_AUTH_SHA384_HMAC] = "sha2-384-hmac",
139 [RTE_CRYPTO_AUTH_SHA512] = "sha2-512",
140 [RTE_CRYPTO_AUTH_SHA512_HMAC] = "sha2-512-hmac",
142 [RTE_CRYPTO_AUTH_KASUMI_F9] = "kasumi-f9",
143 [RTE_CRYPTO_AUTH_SNOW3G_UIA2] = "snow3g-uia2",
144 [RTE_CRYPTO_AUTH_ZUC_EIA3] = "zuc-eia3"
148 * The crypto AEAD algorithm strings identifiers.
149 * It could be used in application command line.
152 rte_crypto_aead_algorithm_strings[] = {
153 [RTE_CRYPTO_AEAD_AES_CCM] = "aes-ccm",
154 [RTE_CRYPTO_AEAD_AES_GCM] = "aes-gcm",
158 * The crypto AEAD operation strings identifiers.
159 * It could be used in application command line.
162 rte_crypto_aead_operation_strings[] = {
163 [RTE_CRYPTO_AEAD_OP_ENCRYPT] = "encrypt",
164 [RTE_CRYPTO_AEAD_OP_DECRYPT] = "decrypt"
168 * Asymmetric crypto transform operation strings identifiers.
170 const char *rte_crypto_asym_xform_strings[] = {
171 [RTE_CRYPTO_ASYM_XFORM_NONE] = "none",
172 [RTE_CRYPTO_ASYM_XFORM_RSA] = "rsa",
173 [RTE_CRYPTO_ASYM_XFORM_MODEX] = "modexp",
174 [RTE_CRYPTO_ASYM_XFORM_MODINV] = "modinv",
175 [RTE_CRYPTO_ASYM_XFORM_DH] = "dh",
176 [RTE_CRYPTO_ASYM_XFORM_DSA] = "dsa",
180 * Asymmetric crypto operation strings identifiers.
182 const char *rte_crypto_asym_op_strings[] = {
183 [RTE_CRYPTO_ASYM_OP_ENCRYPT] = "encrypt",
184 [RTE_CRYPTO_ASYM_OP_DECRYPT] = "decrypt",
185 [RTE_CRYPTO_ASYM_OP_SIGN] = "sign",
186 [RTE_CRYPTO_ASYM_OP_VERIFY] = "verify",
187 [RTE_CRYPTO_ASYM_OP_PRIVATE_KEY_GENERATE] = "priv_key_generate",
188 [RTE_CRYPTO_ASYM_OP_PUBLIC_KEY_GENERATE] = "pub_key_generate",
189 [RTE_CRYPTO_ASYM_OP_SHARED_SECRET_COMPUTE] = "sharedsecret_compute",
193 rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum,
194 const char *algo_string)
198 for (i = 1; i < RTE_DIM(rte_crypto_cipher_algorithm_strings); i++) {
199 if (strcmp(algo_string, rte_crypto_cipher_algorithm_strings[i]) == 0) {
200 *algo_enum = (enum rte_crypto_cipher_algorithm) i;
210 rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum,
211 const char *algo_string)
215 for (i = 1; i < RTE_DIM(rte_crypto_auth_algorithm_strings); i++) {
216 if (strcmp(algo_string, rte_crypto_auth_algorithm_strings[i]) == 0) {
217 *algo_enum = (enum rte_crypto_auth_algorithm) i;
227 rte_cryptodev_get_aead_algo_enum(enum rte_crypto_aead_algorithm *algo_enum,
228 const char *algo_string)
232 for (i = 1; i < RTE_DIM(rte_crypto_aead_algorithm_strings); i++) {
233 if (strcmp(algo_string, rte_crypto_aead_algorithm_strings[i]) == 0) {
234 *algo_enum = (enum rte_crypto_aead_algorithm) i;
243 int __rte_experimental
244 rte_cryptodev_asym_get_xform_enum(enum rte_crypto_asym_xform_type *xform_enum,
245 const char *xform_string)
249 for (i = 1; i < RTE_DIM(rte_crypto_asym_xform_strings); i++) {
250 if (strcmp(xform_string,
251 rte_crypto_asym_xform_strings[i]) == 0) {
252 *xform_enum = (enum rte_crypto_asym_xform_type) i;
262 * The crypto auth operation strings identifiers.
263 * It could be used in application command line.
266 rte_crypto_auth_operation_strings[] = {
267 [RTE_CRYPTO_AUTH_OP_VERIFY] = "verify",
268 [RTE_CRYPTO_AUTH_OP_GENERATE] = "generate"
271 const struct rte_cryptodev_symmetric_capability *
272 rte_cryptodev_sym_capability_get(uint8_t dev_id,
273 const struct rte_cryptodev_sym_capability_idx *idx)
275 const struct rte_cryptodev_capabilities *capability;
276 struct rte_cryptodev_info dev_info;
279 rte_cryptodev_info_get(dev_id, &dev_info);
281 while ((capability = &dev_info.capabilities[i++])->op !=
282 RTE_CRYPTO_OP_TYPE_UNDEFINED) {
283 if (capability->op != RTE_CRYPTO_OP_TYPE_SYMMETRIC)
286 if (capability->sym.xform_type != idx->type)
289 if (idx->type == RTE_CRYPTO_SYM_XFORM_AUTH &&
290 capability->sym.auth.algo == idx->algo.auth)
291 return &capability->sym;
293 if (idx->type == RTE_CRYPTO_SYM_XFORM_CIPHER &&
294 capability->sym.cipher.algo == idx->algo.cipher)
295 return &capability->sym;
297 if (idx->type == RTE_CRYPTO_SYM_XFORM_AEAD &&
298 capability->sym.aead.algo == idx->algo.aead)
299 return &capability->sym;
307 param_range_check(uint16_t size, const struct rte_crypto_param_range *range)
309 unsigned int next_size;
311 /* Check lower/upper bounds */
312 if (size < range->min)
315 if (size > range->max)
318 /* If range is actually only one value, size is correct */
319 if (range->increment == 0)
322 /* Check if value is one of the supported sizes */
323 for (next_size = range->min; next_size <= range->max;
324 next_size += range->increment)
325 if (size == next_size)
331 const struct rte_cryptodev_asymmetric_xform_capability * __rte_experimental
332 rte_cryptodev_asym_capability_get(uint8_t dev_id,
333 const struct rte_cryptodev_asym_capability_idx *idx)
335 const struct rte_cryptodev_capabilities *capability;
336 struct rte_cryptodev_info dev_info;
339 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
340 rte_cryptodev_info_get(dev_id, &dev_info);
342 while ((capability = &dev_info.capabilities[i++])->op !=
343 RTE_CRYPTO_OP_TYPE_UNDEFINED) {
344 if (capability->op != RTE_CRYPTO_OP_TYPE_ASYMMETRIC)
347 if (capability->asym.xform_capa.xform_type == idx->type)
348 return &capability->asym.xform_capa;
354 rte_cryptodev_sym_capability_check_cipher(
355 const struct rte_cryptodev_symmetric_capability *capability,
356 uint16_t key_size, uint16_t iv_size)
358 if (param_range_check(key_size, &capability->cipher.key_size) != 0)
361 if (param_range_check(iv_size, &capability->cipher.iv_size) != 0)
368 rte_cryptodev_sym_capability_check_auth(
369 const struct rte_cryptodev_symmetric_capability *capability,
370 uint16_t key_size, uint16_t digest_size, uint16_t iv_size)
372 if (param_range_check(key_size, &capability->auth.key_size) != 0)
375 if (param_range_check(digest_size, &capability->auth.digest_size) != 0)
378 if (param_range_check(iv_size, &capability->auth.iv_size) != 0)
385 rte_cryptodev_sym_capability_check_aead(
386 const struct rte_cryptodev_symmetric_capability *capability,
387 uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
390 if (param_range_check(key_size, &capability->aead.key_size) != 0)
393 if (param_range_check(digest_size, &capability->aead.digest_size) != 0)
396 if (param_range_check(aad_size, &capability->aead.aad_size) != 0)
399 if (param_range_check(iv_size, &capability->aead.iv_size) != 0)
404 int __rte_experimental
405 rte_cryptodev_asym_xform_capability_check_optype(
406 const struct rte_cryptodev_asymmetric_xform_capability *capability,
407 enum rte_crypto_asym_op_type op_type)
409 if (capability->op_types & (1 << op_type))
415 int __rte_experimental
416 rte_cryptodev_asym_xform_capability_check_modlen(
417 const struct rte_cryptodev_asymmetric_xform_capability *capability,
420 /* no need to check for limits, if min or max = 0 */
421 if (capability->modlen.min != 0) {
422 if (modlen < capability->modlen.min)
426 if (capability->modlen.max != 0) {
427 if (modlen > capability->modlen.max)
431 /* in any case, check if given modlen is module increment */
432 if (capability->modlen.increment != 0) {
433 if (modlen % (capability->modlen.increment))
442 rte_cryptodev_get_feature_name(uint64_t flag)
445 case RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO:
446 return "SYMMETRIC_CRYPTO";
447 case RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO:
448 return "ASYMMETRIC_CRYPTO";
449 case RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING:
450 return "SYM_OPERATION_CHAINING";
451 case RTE_CRYPTODEV_FF_CPU_SSE:
453 case RTE_CRYPTODEV_FF_CPU_AVX:
455 case RTE_CRYPTODEV_FF_CPU_AVX2:
457 case RTE_CRYPTODEV_FF_CPU_AVX512:
459 case RTE_CRYPTODEV_FF_CPU_AESNI:
461 case RTE_CRYPTODEV_FF_HW_ACCELERATED:
462 return "HW_ACCELERATED";
463 case RTE_CRYPTODEV_FF_IN_PLACE_SGL:
464 return "IN_PLACE_SGL";
465 case RTE_CRYPTODEV_FF_OOP_SGL_IN_SGL_OUT:
466 return "OOP_SGL_IN_SGL_OUT";
467 case RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT:
468 return "OOP_SGL_IN_LB_OUT";
469 case RTE_CRYPTODEV_FF_OOP_LB_IN_SGL_OUT:
470 return "OOP_LB_IN_SGL_OUT";
471 case RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT:
472 return "OOP_LB_IN_LB_OUT";
473 case RTE_CRYPTODEV_FF_CPU_NEON:
475 case RTE_CRYPTODEV_FF_CPU_ARM_CE:
477 case RTE_CRYPTODEV_FF_SECURITY:
478 return "SECURITY_PROTOCOL";
484 struct rte_cryptodev *
485 rte_cryptodev_pmd_get_dev(uint8_t dev_id)
487 return &cryptodev_globals.devs[dev_id];
490 struct rte_cryptodev *
491 rte_cryptodev_pmd_get_named_dev(const char *name)
493 struct rte_cryptodev *dev;
499 for (i = 0; i < cryptodev_globals.max_devs; i++) {
500 dev = &cryptodev_globals.devs[i];
502 if ((dev->attached == RTE_CRYPTODEV_ATTACHED) &&
503 (strcmp(dev->data->name, name) == 0))
511 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
513 struct rte_cryptodev *dev = NULL;
515 if (dev_id >= cryptodev_globals.nb_devs)
518 dev = rte_cryptodev_pmd_get_dev(dev_id);
519 if (dev->attached != RTE_CRYPTODEV_ATTACHED)
527 rte_cryptodev_get_dev_id(const char *name)
534 for (i = 0; i < cryptodev_globals.nb_devs; i++)
535 if ((strcmp(cryptodev_globals.devs[i].data->name, name)
537 (cryptodev_globals.devs[i].attached ==
538 RTE_CRYPTODEV_ATTACHED))
545 rte_cryptodev_count(void)
547 return cryptodev_globals.nb_devs;
551 rte_cryptodev_device_count_by_driver(uint8_t driver_id)
553 uint8_t i, dev_count = 0;
555 for (i = 0; i < cryptodev_globals.max_devs; i++)
556 if (cryptodev_globals.devs[i].driver_id == driver_id &&
557 cryptodev_globals.devs[i].attached ==
558 RTE_CRYPTODEV_ATTACHED)
565 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
568 uint8_t i, count = 0;
569 struct rte_cryptodev *devs = cryptodev_globals.devs;
570 uint8_t max_devs = cryptodev_globals.max_devs;
572 for (i = 0; i < max_devs && count < nb_devices; i++) {
574 if (devs[i].attached == RTE_CRYPTODEV_ATTACHED) {
577 cmp = strncmp(devs[i].device->driver->name,
579 strlen(driver_name) + 1);
582 devices[count++] = devs[i].data->dev_id;
590 rte_cryptodev_get_sec_ctx(uint8_t dev_id)
592 if (rte_crypto_devices[dev_id].feature_flags &
593 RTE_CRYPTODEV_FF_SECURITY)
594 return rte_crypto_devices[dev_id].security_ctx;
600 rte_cryptodev_socket_id(uint8_t dev_id)
602 struct rte_cryptodev *dev;
604 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
607 dev = rte_cryptodev_pmd_get_dev(dev_id);
609 return dev->data->socket_id;
613 rte_cryptodev_data_alloc(uint8_t dev_id, struct rte_cryptodev_data **data,
616 char mz_name[RTE_CRYPTODEV_NAME_MAX_LEN];
617 const struct rte_memzone *mz;
620 /* generate memzone name */
621 n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
622 if (n >= (int)sizeof(mz_name))
625 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
626 mz = rte_memzone_reserve(mz_name,
627 sizeof(struct rte_cryptodev_data),
630 mz = rte_memzone_lookup(mz_name);
636 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
637 memset(*data, 0, sizeof(struct rte_cryptodev_data));
643 rte_cryptodev_find_free_device_index(void)
647 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) {
648 if (rte_crypto_devices[dev_id].attached ==
649 RTE_CRYPTODEV_DETACHED)
652 return RTE_CRYPTO_MAX_DEVS;
655 struct rte_cryptodev *
656 rte_cryptodev_pmd_allocate(const char *name, int socket_id)
658 struct rte_cryptodev *cryptodev;
661 if (rte_cryptodev_pmd_get_named_dev(name) != NULL) {
662 CDEV_LOG_ERR("Crypto device with name %s already "
667 dev_id = rte_cryptodev_find_free_device_index();
668 if (dev_id == RTE_CRYPTO_MAX_DEVS) {
669 CDEV_LOG_ERR("Reached maximum number of crypto devices");
673 cryptodev = rte_cryptodev_pmd_get_dev(dev_id);
675 if (cryptodev->data == NULL) {
676 struct rte_cryptodev_data *cryptodev_data =
677 cryptodev_globals.data[dev_id];
679 int retval = rte_cryptodev_data_alloc(dev_id, &cryptodev_data,
682 if (retval < 0 || cryptodev_data == NULL)
685 cryptodev->data = cryptodev_data;
687 snprintf(cryptodev->data->name, RTE_CRYPTODEV_NAME_MAX_LEN,
690 cryptodev->data->dev_id = dev_id;
691 cryptodev->data->socket_id = socket_id;
692 cryptodev->data->dev_started = 0;
694 /* init user callbacks */
695 TAILQ_INIT(&(cryptodev->link_intr_cbs));
697 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
699 cryptodev_globals.nb_devs++;
706 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
710 if (cryptodev == NULL)
713 /* Close device only if device operations have been set */
714 if (cryptodev->dev_ops) {
715 ret = rte_cryptodev_close(cryptodev->data->dev_id);
720 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
721 cryptodev_globals.nb_devs--;
726 rte_cryptodev_queue_pair_count(uint8_t dev_id)
728 struct rte_cryptodev *dev;
730 dev = &rte_crypto_devices[dev_id];
731 return dev->data->nb_queue_pairs;
735 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
738 struct rte_cryptodev_info dev_info;
742 if ((dev == NULL) || (nb_qpairs < 1)) {
743 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
748 CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
749 nb_qpairs, dev->data->dev_id);
751 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
753 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
754 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
756 if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
757 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
758 nb_qpairs, dev->data->dev_id);
762 if (dev->data->queue_pairs == NULL) { /* first time configuration */
763 dev->data->queue_pairs = rte_zmalloc_socket(
764 "cryptodev->queue_pairs",
765 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
766 RTE_CACHE_LINE_SIZE, socket_id);
768 if (dev->data->queue_pairs == NULL) {
769 dev->data->nb_queue_pairs = 0;
770 CDEV_LOG_ERR("failed to get memory for qp meta data, "
775 } else { /* re-configure */
777 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
779 qp = dev->data->queue_pairs;
781 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
784 for (i = nb_qpairs; i < old_nb_queues; i++) {
785 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
790 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
791 RTE_CACHE_LINE_SIZE);
793 CDEV_LOG_ERR("failed to realloc qp meta data,"
794 " nb_queues %u", nb_qpairs);
798 if (nb_qpairs > old_nb_queues) {
799 uint16_t new_qs = nb_qpairs - old_nb_queues;
801 memset(qp + old_nb_queues, 0,
802 sizeof(qp[0]) * new_qs);
805 dev->data->queue_pairs = qp;
808 dev->data->nb_queue_pairs = nb_qpairs;
813 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
815 struct rte_cryptodev *dev;
818 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
819 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
823 dev = &rte_crypto_devices[dev_id];
825 if (dev->data->dev_started) {
827 "device %d must be stopped to allow configuration", dev_id);
831 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
833 /* Setup new number of queue pairs and reconfigure device. */
834 diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
837 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
842 return (*dev->dev_ops->dev_configure)(dev, config);
847 rte_cryptodev_start(uint8_t dev_id)
849 struct rte_cryptodev *dev;
852 CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
854 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
855 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
859 dev = &rte_crypto_devices[dev_id];
861 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
863 if (dev->data->dev_started != 0) {
864 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
869 diag = (*dev->dev_ops->dev_start)(dev);
871 dev->data->dev_started = 1;
879 rte_cryptodev_stop(uint8_t dev_id)
881 struct rte_cryptodev *dev;
883 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
884 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
888 dev = &rte_crypto_devices[dev_id];
890 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
892 if (dev->data->dev_started == 0) {
893 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
898 (*dev->dev_ops->dev_stop)(dev);
899 dev->data->dev_started = 0;
903 rte_cryptodev_close(uint8_t dev_id)
905 struct rte_cryptodev *dev;
908 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
909 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
913 dev = &rte_crypto_devices[dev_id];
915 /* Device must be stopped before it can be closed */
916 if (dev->data->dev_started == 1) {
917 CDEV_LOG_ERR("Device %u must be stopped before closing",
922 /* We can't close the device if there are outstanding sessions in use */
923 if (dev->data->session_pool != NULL) {
924 if (!rte_mempool_full(dev->data->session_pool)) {
925 CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
926 "has sessions still in use, free "
927 "all sessions before calling close",
933 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
934 retval = (*dev->dev_ops->dev_close)(dev);
943 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
944 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id,
945 struct rte_mempool *session_pool)
948 struct rte_cryptodev *dev;
950 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
951 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
955 dev = &rte_crypto_devices[dev_id];
956 if (queue_pair_id >= dev->data->nb_queue_pairs) {
957 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
961 if (dev->data->dev_started) {
963 "device %d must be stopped to allow configuration", dev_id);
967 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
969 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
970 socket_id, session_pool);
975 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
977 struct rte_cryptodev *dev;
979 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
980 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
985 CDEV_LOG_ERR("Invalid stats ptr");
989 dev = &rte_crypto_devices[dev_id];
990 memset(stats, 0, sizeof(*stats));
992 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
993 (*dev->dev_ops->stats_get)(dev, stats);
998 rte_cryptodev_stats_reset(uint8_t dev_id)
1000 struct rte_cryptodev *dev;
1002 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1003 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1007 dev = &rte_crypto_devices[dev_id];
1009 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
1010 (*dev->dev_ops->stats_reset)(dev);
1015 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
1017 struct rte_cryptodev *dev;
1019 if (dev_id >= cryptodev_globals.nb_devs) {
1020 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1024 dev = &rte_crypto_devices[dev_id];
1026 memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
1028 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
1029 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
1031 dev_info->driver_name = dev->device->driver->name;
1032 dev_info->device = dev->device;
1037 rte_cryptodev_callback_register(uint8_t dev_id,
1038 enum rte_cryptodev_event_type event,
1039 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1041 struct rte_cryptodev *dev;
1042 struct rte_cryptodev_callback *user_cb;
1047 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1048 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1052 dev = &rte_crypto_devices[dev_id];
1053 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1055 TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
1056 if (user_cb->cb_fn == cb_fn &&
1057 user_cb->cb_arg == cb_arg &&
1058 user_cb->event == event) {
1063 /* create a new callback. */
1064 if (user_cb == NULL) {
1065 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
1066 sizeof(struct rte_cryptodev_callback), 0);
1067 if (user_cb != NULL) {
1068 user_cb->cb_fn = cb_fn;
1069 user_cb->cb_arg = cb_arg;
1070 user_cb->event = event;
1071 TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
1075 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1076 return (user_cb == NULL) ? -ENOMEM : 0;
1080 rte_cryptodev_callback_unregister(uint8_t dev_id,
1081 enum rte_cryptodev_event_type event,
1082 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1085 struct rte_cryptodev *dev;
1086 struct rte_cryptodev_callback *cb, *next;
1091 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1092 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1096 dev = &rte_crypto_devices[dev_id];
1097 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1100 for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
1102 next = TAILQ_NEXT(cb, next);
1104 if (cb->cb_fn != cb_fn || cb->event != event ||
1105 (cb->cb_arg != (void *)-1 &&
1106 cb->cb_arg != cb_arg))
1110 * if this callback is not executing right now,
1113 if (cb->active == 0) {
1114 TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
1121 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1126 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
1127 enum rte_cryptodev_event_type event)
1129 struct rte_cryptodev_callback *cb_lst;
1130 struct rte_cryptodev_callback dev_cb;
1132 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1133 TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
1134 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
1138 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1139 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
1141 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1144 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1149 rte_cryptodev_sym_session_init(uint8_t dev_id,
1150 struct rte_cryptodev_sym_session *sess,
1151 struct rte_crypto_sym_xform *xforms,
1152 struct rte_mempool *mp)
1154 struct rte_cryptodev *dev;
1158 dev = rte_cryptodev_pmd_get_dev(dev_id);
1160 if (sess == NULL || xforms == NULL || dev == NULL)
1163 index = dev->driver_id;
1165 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->sym_session_configure, -ENOTSUP);
1167 if (sess->sess_private_data[index] == NULL) {
1168 ret = dev->dev_ops->sym_session_configure(dev, xforms,
1172 "dev_id %d failed to configure session details",
1181 int __rte_experimental
1182 rte_cryptodev_asym_session_init(uint8_t dev_id,
1183 struct rte_cryptodev_asym_session *sess,
1184 struct rte_crypto_asym_xform *xforms,
1185 struct rte_mempool *mp)
1187 struct rte_cryptodev *dev;
1191 dev = rte_cryptodev_pmd_get_dev(dev_id);
1193 if (sess == NULL || xforms == NULL || dev == NULL)
1196 index = dev->driver_id;
1198 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->asym_session_configure,
1201 if (sess->sess_private_data[index] == NULL) {
1202 ret = dev->dev_ops->asym_session_configure(dev,
1207 "dev_id %d failed to configure session details",
1216 struct rte_cryptodev_sym_session *
1217 rte_cryptodev_sym_session_create(struct rte_mempool *mp)
1219 struct rte_cryptodev_sym_session *sess;
1221 /* Allocate a session structure from the session pool */
1222 if (rte_mempool_get(mp, (void **)&sess)) {
1223 CDEV_LOG_ERR("couldn't get object from session mempool");
1227 /* Clear device session pointer.
1228 * Include the flag indicating presence of user data
1230 memset(sess, 0, (sizeof(void *) * nb_drivers) + sizeof(uint8_t));
1235 struct rte_cryptodev_asym_session * __rte_experimental
1236 rte_cryptodev_asym_session_create(struct rte_mempool *mp)
1238 struct rte_cryptodev_asym_session *sess;
1240 /* Allocate a session structure from the session pool */
1241 if (rte_mempool_get(mp, (void **)&sess)) {
1242 CDEV_LOG_ERR("couldn't get object from session mempool");
1246 /* Clear device session pointer.
1247 * Include the flag indicating presence of private data
1249 memset(sess, 0, (sizeof(void *) * nb_drivers) + sizeof(uint8_t));
1255 rte_cryptodev_sym_session_clear(uint8_t dev_id,
1256 struct rte_cryptodev_sym_session *sess)
1258 struct rte_cryptodev *dev;
1260 dev = rte_cryptodev_pmd_get_dev(dev_id);
1262 if (dev == NULL || sess == NULL)
1265 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->sym_session_clear, -ENOTSUP);
1267 dev->dev_ops->sym_session_clear(dev, sess);
1272 int __rte_experimental
1273 rte_cryptodev_asym_session_clear(uint8_t dev_id,
1274 struct rte_cryptodev_asym_session *sess)
1276 struct rte_cryptodev *dev;
1278 dev = rte_cryptodev_pmd_get_dev(dev_id);
1280 if (dev == NULL || sess == NULL)
1283 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->asym_session_clear, -ENOTSUP);
1285 dev->dev_ops->asym_session_clear(dev, sess);
1291 rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess)
1295 struct rte_mempool *sess_mp;
1300 /* Check that all device private data has been freed */
1301 for (i = 0; i < nb_drivers; i++) {
1302 sess_priv = get_sym_session_private_data(sess, i);
1303 if (sess_priv != NULL)
1307 /* Return session to mempool */
1308 sess_mp = rte_mempool_from_obj(sess);
1309 rte_mempool_put(sess_mp, sess);
1314 int __rte_experimental
1315 rte_cryptodev_asym_session_free(struct rte_cryptodev_asym_session *sess)
1319 struct rte_mempool *sess_mp;
1324 /* Check that all device private data has been freed */
1325 for (i = 0; i < nb_drivers; i++) {
1326 sess_priv = get_asym_session_private_data(sess, i);
1327 if (sess_priv != NULL)
1331 /* Return session to mempool */
1332 sess_mp = rte_mempool_from_obj(sess);
1333 rte_mempool_put(sess_mp, sess);
1340 rte_cryptodev_sym_get_header_session_size(void)
1343 * Header contains pointers to the private data
1344 * of all registered drivers, and a flag which
1345 * indicates presence of user data
1347 return ((sizeof(void *) * nb_drivers) + sizeof(uint8_t));
1350 unsigned int __rte_experimental
1351 rte_cryptodev_asym_get_header_session_size(void)
1354 * Header contains pointers to the private data
1355 * of all registered drivers, and a flag which
1356 * indicates presence of private data
1358 return ((sizeof(void *) * nb_drivers) + sizeof(uint8_t));
1362 rte_cryptodev_sym_get_private_session_size(uint8_t dev_id)
1364 struct rte_cryptodev *dev;
1365 unsigned int header_size = sizeof(void *) * nb_drivers;
1366 unsigned int priv_sess_size;
1368 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
1371 dev = rte_cryptodev_pmd_get_dev(dev_id);
1373 if (*dev->dev_ops->sym_session_get_size == NULL)
1376 priv_sess_size = (*dev->dev_ops->sym_session_get_size)(dev);
1379 * If size is less than session header size,
1380 * return the latter, as this guarantees that
1381 * sessionless operations will work
1383 if (priv_sess_size < header_size)
1386 return priv_sess_size;
1390 unsigned int __rte_experimental
1391 rte_cryptodev_asym_get_private_session_size(uint8_t dev_id)
1393 struct rte_cryptodev *dev;
1394 unsigned int header_size = sizeof(void *) * nb_drivers;
1395 unsigned int priv_sess_size;
1397 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
1400 dev = rte_cryptodev_pmd_get_dev(dev_id);
1402 if (*dev->dev_ops->asym_session_get_size == NULL)
1405 priv_sess_size = (*dev->dev_ops->asym_session_get_size)(dev);
1406 if (priv_sess_size < header_size)
1409 return priv_sess_size;
1413 int __rte_experimental
1414 rte_cryptodev_sym_session_set_user_data(
1415 struct rte_cryptodev_sym_session *sess,
1419 uint16_t off_set = sizeof(void *) * nb_drivers;
1420 uint8_t *user_data_present = (uint8_t *)sess + off_set;
1425 *user_data_present = 1;
1426 off_set += sizeof(uint8_t);
1427 rte_memcpy((uint8_t *)sess + off_set, data, size);
1431 void * __rte_experimental
1432 rte_cryptodev_sym_session_get_user_data(
1433 struct rte_cryptodev_sym_session *sess)
1435 uint16_t off_set = sizeof(void *) * nb_drivers;
1436 uint8_t *user_data_present = (uint8_t *)sess + off_set;
1438 if (sess == NULL || !*user_data_present)
1441 off_set += sizeof(uint8_t);
1442 return (uint8_t *)sess + off_set;
1445 /** Initialise rte_crypto_op mempool element */
1447 rte_crypto_op_init(struct rte_mempool *mempool,
1450 __rte_unused unsigned i)
1452 struct rte_crypto_op *op = _op_data;
1453 enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
1455 memset(_op_data, 0, mempool->elt_size);
1457 __rte_crypto_op_reset(op, type);
1459 op->phys_addr = rte_mem_virt2iova(_op_data);
1460 op->mempool = mempool;
1464 struct rte_mempool *
1465 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
1466 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
1469 struct rte_crypto_op_pool_private *priv;
1471 unsigned elt_size = sizeof(struct rte_crypto_op) +
1474 if (type == RTE_CRYPTO_OP_TYPE_SYMMETRIC) {
1475 elt_size += sizeof(struct rte_crypto_sym_op);
1476 } else if (type == RTE_CRYPTO_OP_TYPE_ASYMMETRIC) {
1477 elt_size += sizeof(struct rte_crypto_asym_op);
1478 } else if (type == RTE_CRYPTO_OP_TYPE_UNDEFINED) {
1479 elt_size += RTE_MAX(sizeof(struct rte_crypto_sym_op),
1480 sizeof(struct rte_crypto_asym_op));
1482 CDEV_LOG_ERR("Invalid op_type\n");
1486 /* lookup mempool in case already allocated */
1487 struct rte_mempool *mp = rte_mempool_lookup(name);
1490 priv = (struct rte_crypto_op_pool_private *)
1491 rte_mempool_get_priv(mp);
1493 if (mp->elt_size != elt_size ||
1494 mp->cache_size < cache_size ||
1495 mp->size < nb_elts ||
1496 priv->priv_size < priv_size) {
1498 CDEV_LOG_ERR("Mempool %s already exists but with "
1499 "incompatible parameters", name);
1505 mp = rte_mempool_create(
1510 sizeof(struct rte_crypto_op_pool_private),
1519 CDEV_LOG_ERR("Failed to create mempool %s", name);
1523 priv = (struct rte_crypto_op_pool_private *)
1524 rte_mempool_get_priv(mp);
1526 priv->priv_size = priv_size;
1533 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix)
1535 struct rte_cryptodev *dev = NULL;
1541 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
1542 int ret = snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
1543 "%s_%u", dev_name_prefix, i);
1548 dev = rte_cryptodev_pmd_get_named_dev(name);
1556 TAILQ_HEAD(cryptodev_driver_list, cryptodev_driver);
1558 static struct cryptodev_driver_list cryptodev_driver_list =
1559 TAILQ_HEAD_INITIALIZER(cryptodev_driver_list);
1562 rte_cryptodev_driver_id_get(const char *name)
1564 struct cryptodev_driver *driver;
1565 const char *driver_name;
1568 RTE_LOG(DEBUG, CRYPTODEV, "name pointer NULL");
1572 TAILQ_FOREACH(driver, &cryptodev_driver_list, next) {
1573 driver_name = driver->driver->name;
1574 if (strncmp(driver_name, name, strlen(driver_name) + 1) == 0)
1581 rte_cryptodev_name_get(uint8_t dev_id)
1583 struct rte_cryptodev *dev = rte_cryptodev_pmd_get_dev(dev_id);
1588 return dev->data->name;
1592 rte_cryptodev_driver_name_get(uint8_t driver_id)
1594 struct cryptodev_driver *driver;
1596 TAILQ_FOREACH(driver, &cryptodev_driver_list, next)
1597 if (driver->id == driver_id)
1598 return driver->driver->name;
1603 rte_cryptodev_allocate_driver(struct cryptodev_driver *crypto_drv,
1604 const struct rte_driver *drv)
1606 crypto_drv->driver = drv;
1607 crypto_drv->id = nb_drivers;
1609 TAILQ_INSERT_TAIL(&cryptodev_driver_list, crypto_drv, next);
1611 return nb_drivers++;