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 struct rte_cryptodev rte_crypto_devices[RTE_CRYPTO_MAX_DEVS];
48 struct rte_cryptodev *rte_cryptodevs = &rte_crypto_devices[0];
50 static struct rte_cryptodev_global cryptodev_globals = {
51 .devs = &rte_crypto_devices[0],
54 .max_devs = RTE_CRYPTO_MAX_DEVS
57 struct rte_cryptodev_global *rte_cryptodev_globals = &cryptodev_globals;
59 /* spinlock for crypto device callbacks */
60 static rte_spinlock_t rte_cryptodev_cb_lock = RTE_SPINLOCK_INITIALIZER;
64 * The user application callback description.
66 * It contains callback address to be registered by user application,
67 * the pointer to the parameters for callback, and the event type.
69 struct rte_cryptodev_callback {
70 TAILQ_ENTRY(rte_cryptodev_callback) next; /**< Callbacks list */
71 rte_cryptodev_cb_fn cb_fn; /**< Callback address */
72 void *cb_arg; /**< Parameter for callback */
73 enum rte_cryptodev_event_type event; /**< Interrupt event type */
74 uint32_t active; /**< Callback is executing */
78 * The crypto cipher algorithm strings identifiers.
79 * It could be used in application command line.
82 rte_crypto_cipher_algorithm_strings[] = {
83 [RTE_CRYPTO_CIPHER_3DES_CBC] = "3des-cbc",
84 [RTE_CRYPTO_CIPHER_3DES_ECB] = "3des-ecb",
85 [RTE_CRYPTO_CIPHER_3DES_CTR] = "3des-ctr",
87 [RTE_CRYPTO_CIPHER_AES_CBC] = "aes-cbc",
88 [RTE_CRYPTO_CIPHER_AES_CTR] = "aes-ctr",
89 [RTE_CRYPTO_CIPHER_AES_DOCSISBPI] = "aes-docsisbpi",
90 [RTE_CRYPTO_CIPHER_AES_ECB] = "aes-ecb",
91 [RTE_CRYPTO_CIPHER_AES_F8] = "aes-f8",
92 [RTE_CRYPTO_CIPHER_AES_XTS] = "aes-xts",
94 [RTE_CRYPTO_CIPHER_ARC4] = "arc4",
96 [RTE_CRYPTO_CIPHER_DES_CBC] = "des-cbc",
97 [RTE_CRYPTO_CIPHER_DES_DOCSISBPI] = "des-docsisbpi",
99 [RTE_CRYPTO_CIPHER_NULL] = "null",
101 [RTE_CRYPTO_CIPHER_KASUMI_F8] = "kasumi-f8",
102 [RTE_CRYPTO_CIPHER_SNOW3G_UEA2] = "snow3g-uea2",
103 [RTE_CRYPTO_CIPHER_ZUC_EEA3] = "zuc-eea3"
107 * The crypto cipher operation strings identifiers.
108 * It could be used in application command line.
111 rte_crypto_cipher_operation_strings[] = {
112 [RTE_CRYPTO_CIPHER_OP_ENCRYPT] = "encrypt",
113 [RTE_CRYPTO_CIPHER_OP_DECRYPT] = "decrypt"
117 * The crypto auth algorithm strings identifiers.
118 * It could be used in application command line.
121 rte_crypto_auth_algorithm_strings[] = {
122 [RTE_CRYPTO_AUTH_AES_CBC_MAC] = "aes-cbc-mac",
123 [RTE_CRYPTO_AUTH_AES_CMAC] = "aes-cmac",
124 [RTE_CRYPTO_AUTH_AES_GMAC] = "aes-gmac",
125 [RTE_CRYPTO_AUTH_AES_XCBC_MAC] = "aes-xcbc-mac",
127 [RTE_CRYPTO_AUTH_MD5] = "md5",
128 [RTE_CRYPTO_AUTH_MD5_HMAC] = "md5-hmac",
130 [RTE_CRYPTO_AUTH_NULL] = "null",
132 [RTE_CRYPTO_AUTH_SHA1] = "sha1",
133 [RTE_CRYPTO_AUTH_SHA1_HMAC] = "sha1-hmac",
135 [RTE_CRYPTO_AUTH_SHA224] = "sha2-224",
136 [RTE_CRYPTO_AUTH_SHA224_HMAC] = "sha2-224-hmac",
137 [RTE_CRYPTO_AUTH_SHA256] = "sha2-256",
138 [RTE_CRYPTO_AUTH_SHA256_HMAC] = "sha2-256-hmac",
139 [RTE_CRYPTO_AUTH_SHA384] = "sha2-384",
140 [RTE_CRYPTO_AUTH_SHA384_HMAC] = "sha2-384-hmac",
141 [RTE_CRYPTO_AUTH_SHA512] = "sha2-512",
142 [RTE_CRYPTO_AUTH_SHA512_HMAC] = "sha2-512-hmac",
144 [RTE_CRYPTO_AUTH_KASUMI_F9] = "kasumi-f9",
145 [RTE_CRYPTO_AUTH_SNOW3G_UIA2] = "snow3g-uia2",
146 [RTE_CRYPTO_AUTH_ZUC_EIA3] = "zuc-eia3"
150 * The crypto AEAD algorithm strings identifiers.
151 * It could be used in application command line.
154 rte_crypto_aead_algorithm_strings[] = {
155 [RTE_CRYPTO_AEAD_AES_CCM] = "aes-ccm",
156 [RTE_CRYPTO_AEAD_AES_GCM] = "aes-gcm",
160 * The crypto AEAD operation strings identifiers.
161 * It could be used in application command line.
164 rte_crypto_aead_operation_strings[] = {
165 [RTE_CRYPTO_AEAD_OP_ENCRYPT] = "encrypt",
166 [RTE_CRYPTO_AEAD_OP_DECRYPT] = "decrypt"
170 * Asymmetric crypto transform operation strings identifiers.
172 const char *rte_crypto_asym_xform_strings[] = {
173 [RTE_CRYPTO_ASYM_XFORM_NONE] = "none",
174 [RTE_CRYPTO_ASYM_XFORM_RSA] = "rsa",
175 [RTE_CRYPTO_ASYM_XFORM_MODEX] = "modexp",
176 [RTE_CRYPTO_ASYM_XFORM_MODINV] = "modinv",
177 [RTE_CRYPTO_ASYM_XFORM_DH] = "dh",
178 [RTE_CRYPTO_ASYM_XFORM_DSA] = "dsa",
182 * Asymmetric crypto operation strings identifiers.
184 const char *rte_crypto_asym_op_strings[] = {
185 [RTE_CRYPTO_ASYM_OP_ENCRYPT] = "encrypt",
186 [RTE_CRYPTO_ASYM_OP_DECRYPT] = "decrypt",
187 [RTE_CRYPTO_ASYM_OP_SIGN] = "sign",
188 [RTE_CRYPTO_ASYM_OP_VERIFY] = "verify",
189 [RTE_CRYPTO_ASYM_OP_PRIVATE_KEY_GENERATE] = "priv_key_generate",
190 [RTE_CRYPTO_ASYM_OP_PUBLIC_KEY_GENERATE] = "pub_key_generate",
191 [RTE_CRYPTO_ASYM_OP_SHARED_SECRET_COMPUTE] = "sharedsecret_compute",
195 rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum,
196 const char *algo_string)
200 for (i = 1; i < RTE_DIM(rte_crypto_cipher_algorithm_strings); i++) {
201 if (strcmp(algo_string, rte_crypto_cipher_algorithm_strings[i]) == 0) {
202 *algo_enum = (enum rte_crypto_cipher_algorithm) i;
212 rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum,
213 const char *algo_string)
217 for (i = 1; i < RTE_DIM(rte_crypto_auth_algorithm_strings); i++) {
218 if (strcmp(algo_string, rte_crypto_auth_algorithm_strings[i]) == 0) {
219 *algo_enum = (enum rte_crypto_auth_algorithm) i;
229 rte_cryptodev_get_aead_algo_enum(enum rte_crypto_aead_algorithm *algo_enum,
230 const char *algo_string)
234 for (i = 1; i < RTE_DIM(rte_crypto_aead_algorithm_strings); i++) {
235 if (strcmp(algo_string, rte_crypto_aead_algorithm_strings[i]) == 0) {
236 *algo_enum = (enum rte_crypto_aead_algorithm) i;
245 int __rte_experimental
246 rte_cryptodev_asym_get_xform_enum(enum rte_crypto_asym_xform_type *xform_enum,
247 const char *xform_string)
251 for (i = 1; i < RTE_DIM(rte_crypto_asym_xform_strings); i++) {
252 if (strcmp(xform_string,
253 rte_crypto_asym_xform_strings[i]) == 0) {
254 *xform_enum = (enum rte_crypto_asym_xform_type) i;
264 * The crypto auth operation strings identifiers.
265 * It could be used in application command line.
268 rte_crypto_auth_operation_strings[] = {
269 [RTE_CRYPTO_AUTH_OP_VERIFY] = "verify",
270 [RTE_CRYPTO_AUTH_OP_GENERATE] = "generate"
273 const struct rte_cryptodev_symmetric_capability *
274 rte_cryptodev_sym_capability_get(uint8_t dev_id,
275 const struct rte_cryptodev_sym_capability_idx *idx)
277 const struct rte_cryptodev_capabilities *capability;
278 struct rte_cryptodev_info dev_info;
281 rte_cryptodev_info_get(dev_id, &dev_info);
283 while ((capability = &dev_info.capabilities[i++])->op !=
284 RTE_CRYPTO_OP_TYPE_UNDEFINED) {
285 if (capability->op != RTE_CRYPTO_OP_TYPE_SYMMETRIC)
288 if (capability->sym.xform_type != idx->type)
291 if (idx->type == RTE_CRYPTO_SYM_XFORM_AUTH &&
292 capability->sym.auth.algo == idx->algo.auth)
293 return &capability->sym;
295 if (idx->type == RTE_CRYPTO_SYM_XFORM_CIPHER &&
296 capability->sym.cipher.algo == idx->algo.cipher)
297 return &capability->sym;
299 if (idx->type == RTE_CRYPTO_SYM_XFORM_AEAD &&
300 capability->sym.aead.algo == idx->algo.aead)
301 return &capability->sym;
309 param_range_check(uint16_t size, const struct rte_crypto_param_range *range)
311 unsigned int next_size;
313 /* Check lower/upper bounds */
314 if (size < range->min)
317 if (size > range->max)
320 /* If range is actually only one value, size is correct */
321 if (range->increment == 0)
324 /* Check if value is one of the supported sizes */
325 for (next_size = range->min; next_size <= range->max;
326 next_size += range->increment)
327 if (size == next_size)
333 const struct rte_cryptodev_asymmetric_xform_capability * __rte_experimental
334 rte_cryptodev_asym_capability_get(uint8_t dev_id,
335 const struct rte_cryptodev_asym_capability_idx *idx)
337 const struct rte_cryptodev_capabilities *capability;
338 struct rte_cryptodev_info dev_info;
341 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
342 rte_cryptodev_info_get(dev_id, &dev_info);
344 while ((capability = &dev_info.capabilities[i++])->op !=
345 RTE_CRYPTO_OP_TYPE_UNDEFINED) {
346 if (capability->op != RTE_CRYPTO_OP_TYPE_ASYMMETRIC)
349 if (capability->asym.xform_capa.xform_type == idx->type)
350 return &capability->asym.xform_capa;
356 rte_cryptodev_sym_capability_check_cipher(
357 const struct rte_cryptodev_symmetric_capability *capability,
358 uint16_t key_size, uint16_t iv_size)
360 if (param_range_check(key_size, &capability->cipher.key_size) != 0)
363 if (param_range_check(iv_size, &capability->cipher.iv_size) != 0)
370 rte_cryptodev_sym_capability_check_auth(
371 const struct rte_cryptodev_symmetric_capability *capability,
372 uint16_t key_size, uint16_t digest_size, uint16_t iv_size)
374 if (param_range_check(key_size, &capability->auth.key_size) != 0)
377 if (param_range_check(digest_size, &capability->auth.digest_size) != 0)
380 if (param_range_check(iv_size, &capability->auth.iv_size) != 0)
387 rte_cryptodev_sym_capability_check_aead(
388 const struct rte_cryptodev_symmetric_capability *capability,
389 uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
392 if (param_range_check(key_size, &capability->aead.key_size) != 0)
395 if (param_range_check(digest_size, &capability->aead.digest_size) != 0)
398 if (param_range_check(aad_size, &capability->aead.aad_size) != 0)
401 if (param_range_check(iv_size, &capability->aead.iv_size) != 0)
406 int __rte_experimental
407 rte_cryptodev_asym_xform_capability_check_optype(
408 const struct rte_cryptodev_asymmetric_xform_capability *capability,
409 enum rte_crypto_asym_op_type op_type)
411 if (capability->op_types & (1 << op_type))
417 int __rte_experimental
418 rte_cryptodev_asym_xform_capability_check_modlen(
419 const struct rte_cryptodev_asymmetric_xform_capability *capability,
422 /* no need to check for limits, if min or max = 0 */
423 if (capability->modlen.min != 0) {
424 if (modlen < capability->modlen.min)
428 if (capability->modlen.max != 0) {
429 if (modlen > capability->modlen.max)
433 /* in any case, check if given modlen is module increment */
434 if (capability->modlen.increment != 0) {
435 if (modlen % (capability->modlen.increment))
444 rte_cryptodev_get_feature_name(uint64_t flag)
447 case RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO:
448 return "SYMMETRIC_CRYPTO";
449 case RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO:
450 return "ASYMMETRIC_CRYPTO";
451 case RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING:
452 return "SYM_OPERATION_CHAINING";
453 case RTE_CRYPTODEV_FF_CPU_SSE:
455 case RTE_CRYPTODEV_FF_CPU_AVX:
457 case RTE_CRYPTODEV_FF_CPU_AVX2:
459 case RTE_CRYPTODEV_FF_CPU_AVX512:
461 case RTE_CRYPTODEV_FF_CPU_AESNI:
463 case RTE_CRYPTODEV_FF_HW_ACCELERATED:
464 return "HW_ACCELERATED";
465 case RTE_CRYPTODEV_FF_IN_PLACE_SGL:
466 return "IN_PLACE_SGL";
467 case RTE_CRYPTODEV_FF_OOP_SGL_IN_SGL_OUT:
468 return "OOP_SGL_IN_SGL_OUT";
469 case RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT:
470 return "OOP_SGL_IN_LB_OUT";
471 case RTE_CRYPTODEV_FF_OOP_LB_IN_SGL_OUT:
472 return "OOP_LB_IN_SGL_OUT";
473 case RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT:
474 return "OOP_LB_IN_LB_OUT";
475 case RTE_CRYPTODEV_FF_CPU_NEON:
477 case RTE_CRYPTODEV_FF_CPU_ARM_CE:
479 case RTE_CRYPTODEV_FF_SECURITY:
480 return "SECURITY_PROTOCOL";
486 struct rte_cryptodev *
487 rte_cryptodev_pmd_get_dev(uint8_t dev_id)
489 return &rte_cryptodev_globals->devs[dev_id];
492 struct rte_cryptodev *
493 rte_cryptodev_pmd_get_named_dev(const char *name)
495 struct rte_cryptodev *dev;
501 for (i = 0; i < rte_cryptodev_globals->max_devs; i++) {
502 dev = &rte_cryptodev_globals->devs[i];
504 if ((dev->attached == RTE_CRYPTODEV_ATTACHED) &&
505 (strcmp(dev->data->name, name) == 0))
513 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
515 struct rte_cryptodev *dev = NULL;
517 if (dev_id >= rte_cryptodev_globals->nb_devs)
520 dev = rte_cryptodev_pmd_get_dev(dev_id);
521 if (dev->attached != RTE_CRYPTODEV_ATTACHED)
529 rte_cryptodev_get_dev_id(const char *name)
536 for (i = 0; i < rte_cryptodev_globals->nb_devs; i++)
537 if ((strcmp(rte_cryptodev_globals->devs[i].data->name, name)
539 (rte_cryptodev_globals->devs[i].attached ==
540 RTE_CRYPTODEV_ATTACHED))
547 rte_cryptodev_count(void)
549 return rte_cryptodev_globals->nb_devs;
553 rte_cryptodev_device_count_by_driver(uint8_t driver_id)
555 uint8_t i, dev_count = 0;
557 for (i = 0; i < rte_cryptodev_globals->max_devs; i++)
558 if (rte_cryptodev_globals->devs[i].driver_id == driver_id &&
559 rte_cryptodev_globals->devs[i].attached ==
560 RTE_CRYPTODEV_ATTACHED)
567 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
570 uint8_t i, count = 0;
571 struct rte_cryptodev *devs = rte_cryptodev_globals->devs;
572 uint8_t max_devs = rte_cryptodev_globals->max_devs;
574 for (i = 0; i < max_devs && count < nb_devices; i++) {
576 if (devs[i].attached == RTE_CRYPTODEV_ATTACHED) {
579 cmp = strncmp(devs[i].device->driver->name,
581 strlen(driver_name));
584 devices[count++] = devs[i].data->dev_id;
592 rte_cryptodev_get_sec_ctx(uint8_t dev_id)
594 if (rte_crypto_devices[dev_id].feature_flags &
595 RTE_CRYPTODEV_FF_SECURITY)
596 return rte_crypto_devices[dev_id].security_ctx;
602 rte_cryptodev_socket_id(uint8_t dev_id)
604 struct rte_cryptodev *dev;
606 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
609 dev = rte_cryptodev_pmd_get_dev(dev_id);
611 return dev->data->socket_id;
615 rte_cryptodev_data_alloc(uint8_t dev_id, struct rte_cryptodev_data **data,
618 char mz_name[RTE_CRYPTODEV_NAME_MAX_LEN];
619 const struct rte_memzone *mz;
622 /* generate memzone name */
623 n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
624 if (n >= (int)sizeof(mz_name))
627 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
628 mz = rte_memzone_reserve(mz_name,
629 sizeof(struct rte_cryptodev_data),
632 mz = rte_memzone_lookup(mz_name);
638 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
639 memset(*data, 0, sizeof(struct rte_cryptodev_data));
645 rte_cryptodev_find_free_device_index(void)
649 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) {
650 if (rte_crypto_devices[dev_id].attached ==
651 RTE_CRYPTODEV_DETACHED)
654 return RTE_CRYPTO_MAX_DEVS;
657 struct rte_cryptodev *
658 rte_cryptodev_pmd_allocate(const char *name, int socket_id)
660 struct rte_cryptodev *cryptodev;
663 if (rte_cryptodev_pmd_get_named_dev(name) != NULL) {
664 CDEV_LOG_ERR("Crypto device with name %s already "
669 dev_id = rte_cryptodev_find_free_device_index();
670 if (dev_id == RTE_CRYPTO_MAX_DEVS) {
671 CDEV_LOG_ERR("Reached maximum number of crypto devices");
675 cryptodev = rte_cryptodev_pmd_get_dev(dev_id);
677 if (cryptodev->data == NULL) {
678 struct rte_cryptodev_data *cryptodev_data =
679 cryptodev_globals.data[dev_id];
681 int retval = rte_cryptodev_data_alloc(dev_id, &cryptodev_data,
684 if (retval < 0 || cryptodev_data == NULL)
687 cryptodev->data = cryptodev_data;
689 snprintf(cryptodev->data->name, RTE_CRYPTODEV_NAME_MAX_LEN,
692 cryptodev->data->dev_id = dev_id;
693 cryptodev->data->socket_id = socket_id;
694 cryptodev->data->dev_started = 0;
696 /* init user callbacks */
697 TAILQ_INIT(&(cryptodev->link_intr_cbs));
699 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
701 cryptodev_globals.nb_devs++;
708 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
712 if (cryptodev == NULL)
715 /* Close device only if device operations have been set */
716 if (cryptodev->dev_ops) {
717 ret = rte_cryptodev_close(cryptodev->data->dev_id);
722 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
723 cryptodev_globals.nb_devs--;
728 rte_cryptodev_queue_pair_count(uint8_t dev_id)
730 struct rte_cryptodev *dev;
732 dev = &rte_crypto_devices[dev_id];
733 return dev->data->nb_queue_pairs;
737 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
740 struct rte_cryptodev_info dev_info;
744 if ((dev == NULL) || (nb_qpairs < 1)) {
745 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
750 CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
751 nb_qpairs, dev->data->dev_id);
753 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
755 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
756 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
758 if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
759 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
760 nb_qpairs, dev->data->dev_id);
764 if (dev->data->queue_pairs == NULL) { /* first time configuration */
765 dev->data->queue_pairs = rte_zmalloc_socket(
766 "cryptodev->queue_pairs",
767 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
768 RTE_CACHE_LINE_SIZE, socket_id);
770 if (dev->data->queue_pairs == NULL) {
771 dev->data->nb_queue_pairs = 0;
772 CDEV_LOG_ERR("failed to get memory for qp meta data, "
777 } else { /* re-configure */
779 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
781 qp = dev->data->queue_pairs;
783 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
786 for (i = nb_qpairs; i < old_nb_queues; i++) {
787 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
792 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
793 RTE_CACHE_LINE_SIZE);
795 CDEV_LOG_ERR("failed to realloc qp meta data,"
796 " nb_queues %u", nb_qpairs);
800 if (nb_qpairs > old_nb_queues) {
801 uint16_t new_qs = nb_qpairs - old_nb_queues;
803 memset(qp + old_nb_queues, 0,
804 sizeof(qp[0]) * new_qs);
807 dev->data->queue_pairs = qp;
810 dev->data->nb_queue_pairs = nb_qpairs;
815 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
817 struct rte_cryptodev *dev;
820 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
821 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
825 dev = &rte_crypto_devices[dev_id];
827 if (dev->data->dev_started) {
829 "device %d must be stopped to allow configuration", dev_id);
833 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
835 /* Setup new number of queue pairs and reconfigure device. */
836 diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
839 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
844 return (*dev->dev_ops->dev_configure)(dev, config);
849 rte_cryptodev_start(uint8_t dev_id)
851 struct rte_cryptodev *dev;
854 CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
856 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
857 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
861 dev = &rte_crypto_devices[dev_id];
863 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
865 if (dev->data->dev_started != 0) {
866 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
871 diag = (*dev->dev_ops->dev_start)(dev);
873 dev->data->dev_started = 1;
881 rte_cryptodev_stop(uint8_t dev_id)
883 struct rte_cryptodev *dev;
885 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
886 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
890 dev = &rte_crypto_devices[dev_id];
892 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
894 if (dev->data->dev_started == 0) {
895 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
900 (*dev->dev_ops->dev_stop)(dev);
901 dev->data->dev_started = 0;
905 rte_cryptodev_close(uint8_t dev_id)
907 struct rte_cryptodev *dev;
910 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
911 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
915 dev = &rte_crypto_devices[dev_id];
917 /* Device must be stopped before it can be closed */
918 if (dev->data->dev_started == 1) {
919 CDEV_LOG_ERR("Device %u must be stopped before closing",
924 /* We can't close the device if there are outstanding sessions in use */
925 if (dev->data->session_pool != NULL) {
926 if (!rte_mempool_full(dev->data->session_pool)) {
927 CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
928 "has sessions still in use, free "
929 "all sessions before calling close",
935 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
936 retval = (*dev->dev_ops->dev_close)(dev);
945 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
946 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id,
947 struct rte_mempool *session_pool)
950 struct rte_cryptodev *dev;
952 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
953 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
957 dev = &rte_crypto_devices[dev_id];
958 if (queue_pair_id >= dev->data->nb_queue_pairs) {
959 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
963 if (dev->data->dev_started) {
965 "device %d must be stopped to allow configuration", dev_id);
969 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
971 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
972 socket_id, session_pool);
977 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
979 struct rte_cryptodev *dev;
981 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
982 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
987 CDEV_LOG_ERR("Invalid stats ptr");
991 dev = &rte_crypto_devices[dev_id];
992 memset(stats, 0, sizeof(*stats));
994 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
995 (*dev->dev_ops->stats_get)(dev, stats);
1000 rte_cryptodev_stats_reset(uint8_t dev_id)
1002 struct rte_cryptodev *dev;
1004 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1005 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1009 dev = &rte_crypto_devices[dev_id];
1011 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
1012 (*dev->dev_ops->stats_reset)(dev);
1017 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
1019 struct rte_cryptodev *dev;
1021 if (dev_id >= cryptodev_globals.nb_devs) {
1022 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1026 dev = &rte_crypto_devices[dev_id];
1028 memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
1030 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
1031 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
1033 dev_info->driver_name = dev->device->driver->name;
1034 dev_info->device = dev->device;
1039 rte_cryptodev_callback_register(uint8_t dev_id,
1040 enum rte_cryptodev_event_type event,
1041 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1043 struct rte_cryptodev *dev;
1044 struct rte_cryptodev_callback *user_cb;
1049 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1050 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1054 dev = &rte_crypto_devices[dev_id];
1055 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1057 TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
1058 if (user_cb->cb_fn == cb_fn &&
1059 user_cb->cb_arg == cb_arg &&
1060 user_cb->event == event) {
1065 /* create a new callback. */
1066 if (user_cb == NULL) {
1067 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
1068 sizeof(struct rte_cryptodev_callback), 0);
1069 if (user_cb != NULL) {
1070 user_cb->cb_fn = cb_fn;
1071 user_cb->cb_arg = cb_arg;
1072 user_cb->event = event;
1073 TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
1077 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1078 return (user_cb == NULL) ? -ENOMEM : 0;
1082 rte_cryptodev_callback_unregister(uint8_t dev_id,
1083 enum rte_cryptodev_event_type event,
1084 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1087 struct rte_cryptodev *dev;
1088 struct rte_cryptodev_callback *cb, *next;
1093 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1094 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1098 dev = &rte_crypto_devices[dev_id];
1099 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1102 for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
1104 next = TAILQ_NEXT(cb, next);
1106 if (cb->cb_fn != cb_fn || cb->event != event ||
1107 (cb->cb_arg != (void *)-1 &&
1108 cb->cb_arg != cb_arg))
1112 * if this callback is not executing right now,
1115 if (cb->active == 0) {
1116 TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
1123 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1128 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
1129 enum rte_cryptodev_event_type event)
1131 struct rte_cryptodev_callback *cb_lst;
1132 struct rte_cryptodev_callback dev_cb;
1134 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1135 TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
1136 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
1140 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1141 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
1143 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1146 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1151 rte_cryptodev_sym_session_init(uint8_t dev_id,
1152 struct rte_cryptodev_sym_session *sess,
1153 struct rte_crypto_sym_xform *xforms,
1154 struct rte_mempool *mp)
1156 struct rte_cryptodev *dev;
1160 dev = rte_cryptodev_pmd_get_dev(dev_id);
1162 if (sess == NULL || xforms == NULL || dev == NULL)
1165 index = dev->driver_id;
1167 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->sym_session_configure, -ENOTSUP);
1169 if (sess->sess_private_data[index] == NULL) {
1170 ret = dev->dev_ops->sym_session_configure(dev, xforms,
1174 "dev_id %d failed to configure session details",
1183 int __rte_experimental
1184 rte_cryptodev_asym_session_init(uint8_t dev_id,
1185 struct rte_cryptodev_asym_session *sess,
1186 struct rte_crypto_asym_xform *xforms,
1187 struct rte_mempool *mp)
1189 struct rte_cryptodev *dev;
1193 dev = rte_cryptodev_pmd_get_dev(dev_id);
1195 if (sess == NULL || xforms == NULL || dev == NULL)
1198 index = dev->driver_id;
1200 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->asym_session_configure,
1203 if (sess->sess_private_data[index] == NULL) {
1204 ret = dev->dev_ops->asym_session_configure(dev,
1209 "dev_id %d failed to configure session details",
1218 struct rte_cryptodev_sym_session *
1219 rte_cryptodev_sym_session_create(struct rte_mempool *mp)
1221 struct rte_cryptodev_sym_session *sess;
1223 /* Allocate a session structure from the session pool */
1224 if (rte_mempool_get(mp, (void **)&sess)) {
1225 CDEV_LOG_ERR("couldn't get object from session mempool");
1229 /* Clear device session pointer.
1230 * Include the flag indicating presence of user data
1232 memset(sess, 0, (sizeof(void *) * nb_drivers) + sizeof(uint8_t));
1237 struct rte_cryptodev_asym_session * __rte_experimental
1238 rte_cryptodev_asym_session_create(struct rte_mempool *mp)
1240 struct rte_cryptodev_asym_session *sess;
1242 /* Allocate a session structure from the session pool */
1243 if (rte_mempool_get(mp, (void **)&sess)) {
1244 CDEV_LOG_ERR("couldn't get object from session mempool");
1248 /* Clear device session pointer.
1249 * Include the flag indicating presence of private data
1251 memset(sess, 0, (sizeof(void *) * nb_drivers) + sizeof(uint8_t));
1257 rte_cryptodev_sym_session_clear(uint8_t dev_id,
1258 struct rte_cryptodev_sym_session *sess)
1260 struct rte_cryptodev *dev;
1262 dev = rte_cryptodev_pmd_get_dev(dev_id);
1264 if (dev == NULL || sess == NULL)
1267 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->sym_session_clear, -ENOTSUP);
1269 dev->dev_ops->sym_session_clear(dev, sess);
1274 int __rte_experimental
1275 rte_cryptodev_asym_session_clear(uint8_t dev_id,
1276 struct rte_cryptodev_asym_session *sess)
1278 struct rte_cryptodev *dev;
1280 dev = rte_cryptodev_pmd_get_dev(dev_id);
1282 if (dev == NULL || sess == NULL)
1285 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->asym_session_clear, -ENOTSUP);
1287 dev->dev_ops->asym_session_clear(dev, sess);
1293 rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess)
1297 struct rte_mempool *sess_mp;
1302 /* Check that all device private data has been freed */
1303 for (i = 0; i < nb_drivers; i++) {
1304 sess_priv = get_sym_session_private_data(sess, i);
1305 if (sess_priv != NULL)
1309 /* Return session to mempool */
1310 sess_mp = rte_mempool_from_obj(sess);
1311 rte_mempool_put(sess_mp, sess);
1316 int __rte_experimental
1317 rte_cryptodev_asym_session_free(struct rte_cryptodev_asym_session *sess)
1321 struct rte_mempool *sess_mp;
1326 /* Check that all device private data has been freed */
1327 for (i = 0; i < nb_drivers; i++) {
1328 sess_priv = get_asym_session_private_data(sess, i);
1329 if (sess_priv != NULL)
1333 /* Return session to mempool */
1334 sess_mp = rte_mempool_from_obj(sess);
1335 rte_mempool_put(sess_mp, sess);
1342 rte_cryptodev_sym_get_header_session_size(void)
1345 * Header contains pointers to the private data
1346 * of all registered drivers, and a flag which
1347 * indicates presence of user data
1349 return ((sizeof(void *) * nb_drivers) + sizeof(uint8_t));
1352 unsigned int __rte_experimental
1353 rte_cryptodev_asym_get_header_session_size(void)
1356 * Header contains pointers to the private data
1357 * of all registered drivers, and a flag which
1358 * indicates presence of private data
1360 return ((sizeof(void *) * nb_drivers) + sizeof(uint8_t));
1364 rte_cryptodev_sym_get_private_session_size(uint8_t dev_id)
1366 struct rte_cryptodev *dev;
1367 unsigned int header_size = sizeof(void *) * nb_drivers;
1368 unsigned int priv_sess_size;
1370 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
1373 dev = rte_cryptodev_pmd_get_dev(dev_id);
1375 if (*dev->dev_ops->sym_session_get_size == NULL)
1378 priv_sess_size = (*dev->dev_ops->sym_session_get_size)(dev);
1381 * If size is less than session header size,
1382 * return the latter, as this guarantees that
1383 * sessionless operations will work
1385 if (priv_sess_size < header_size)
1388 return priv_sess_size;
1392 unsigned int __rte_experimental
1393 rte_cryptodev_asym_get_private_session_size(uint8_t dev_id)
1395 struct rte_cryptodev *dev;
1396 unsigned int header_size = sizeof(void *) * nb_drivers;
1397 unsigned int priv_sess_size;
1399 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
1402 dev = rte_cryptodev_pmd_get_dev(dev_id);
1404 if (*dev->dev_ops->asym_session_get_size == NULL)
1407 priv_sess_size = (*dev->dev_ops->asym_session_get_size)(dev);
1408 if (priv_sess_size < header_size)
1411 return priv_sess_size;
1415 int __rte_experimental
1416 rte_cryptodev_sym_session_set_user_data(
1417 struct rte_cryptodev_sym_session *sess,
1421 uint16_t off_set = sizeof(void *) * nb_drivers;
1422 uint8_t *user_data_present = (uint8_t *)sess + off_set;
1427 *user_data_present = 1;
1428 off_set += sizeof(uint8_t);
1429 rte_memcpy((uint8_t *)sess + off_set, data, size);
1433 void * __rte_experimental
1434 rte_cryptodev_sym_session_get_user_data(
1435 struct rte_cryptodev_sym_session *sess)
1437 uint16_t off_set = sizeof(void *) * nb_drivers;
1438 uint8_t *user_data_present = (uint8_t *)sess + off_set;
1440 if (sess == NULL || !*user_data_present)
1443 off_set += sizeof(uint8_t);
1444 return (uint8_t *)sess + off_set;
1447 /** Initialise rte_crypto_op mempool element */
1449 rte_crypto_op_init(struct rte_mempool *mempool,
1452 __rte_unused unsigned i)
1454 struct rte_crypto_op *op = _op_data;
1455 enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
1457 memset(_op_data, 0, mempool->elt_size);
1459 __rte_crypto_op_reset(op, type);
1461 op->phys_addr = rte_mem_virt2iova(_op_data);
1462 op->mempool = mempool;
1466 struct rte_mempool *
1467 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
1468 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
1471 struct rte_crypto_op_pool_private *priv;
1473 unsigned elt_size = sizeof(struct rte_crypto_op) +
1476 if (type == RTE_CRYPTO_OP_TYPE_SYMMETRIC) {
1477 elt_size += sizeof(struct rte_crypto_sym_op);
1478 } else if (type == RTE_CRYPTO_OP_TYPE_ASYMMETRIC) {
1479 elt_size += sizeof(struct rte_crypto_asym_op);
1481 CDEV_LOG_ERR("Invalid op_type\n");
1485 /* lookup mempool in case already allocated */
1486 struct rte_mempool *mp = rte_mempool_lookup(name);
1489 priv = (struct rte_crypto_op_pool_private *)
1490 rte_mempool_get_priv(mp);
1492 if (mp->elt_size != elt_size ||
1493 mp->cache_size < cache_size ||
1494 mp->size < nb_elts ||
1495 priv->priv_size < priv_size) {
1497 CDEV_LOG_ERR("Mempool %s already exists but with "
1498 "incompatible parameters", name);
1504 mp = rte_mempool_create(
1509 sizeof(struct rte_crypto_op_pool_private),
1518 CDEV_LOG_ERR("Failed to create mempool %s", name);
1522 priv = (struct rte_crypto_op_pool_private *)
1523 rte_mempool_get_priv(mp);
1525 priv->priv_size = priv_size;
1532 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix)
1534 struct rte_cryptodev *dev = NULL;
1540 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
1541 int ret = snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
1542 "%s_%u", dev_name_prefix, i);
1547 dev = rte_cryptodev_pmd_get_named_dev(name);
1555 TAILQ_HEAD(cryptodev_driver_list, cryptodev_driver);
1557 static struct cryptodev_driver_list cryptodev_driver_list =
1558 TAILQ_HEAD_INITIALIZER(cryptodev_driver_list);
1561 rte_cryptodev_driver_id_get(const char *name)
1563 struct cryptodev_driver *driver;
1564 const char *driver_name;
1567 RTE_LOG(DEBUG, CRYPTODEV, "name pointer NULL");
1571 TAILQ_FOREACH(driver, &cryptodev_driver_list, next) {
1572 driver_name = driver->driver->name;
1573 if (strncmp(driver_name, name, strlen(driver_name)) == 0)
1580 rte_cryptodev_name_get(uint8_t dev_id)
1582 struct rte_cryptodev *dev = rte_cryptodev_pmd_get_dev(dev_id);
1587 return dev->data->name;
1591 rte_cryptodev_driver_name_get(uint8_t driver_id)
1593 struct cryptodev_driver *driver;
1595 TAILQ_FOREACH(driver, &cryptodev_driver_list, next)
1596 if (driver->id == driver_id)
1597 return driver->driver->name;
1602 rte_cryptodev_allocate_driver(struct cryptodev_driver *crypto_drv,
1603 const struct rte_driver *drv)
1605 crypto_drv->driver = drv;
1606 crypto_drv->id = nb_drivers;
1608 TAILQ_INSERT_TAIL(&cryptodev_driver_list, crypto_drv, next);
1610 return nb_drivers++;