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 rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum,
171 const char *algo_string)
175 for (i = 1; i < RTE_DIM(rte_crypto_cipher_algorithm_strings); i++) {
176 if (strcmp(algo_string, rte_crypto_cipher_algorithm_strings[i]) == 0) {
177 *algo_enum = (enum rte_crypto_cipher_algorithm) i;
187 rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum,
188 const char *algo_string)
192 for (i = 1; i < RTE_DIM(rte_crypto_auth_algorithm_strings); i++) {
193 if (strcmp(algo_string, rte_crypto_auth_algorithm_strings[i]) == 0) {
194 *algo_enum = (enum rte_crypto_auth_algorithm) i;
204 rte_cryptodev_get_aead_algo_enum(enum rte_crypto_aead_algorithm *algo_enum,
205 const char *algo_string)
209 for (i = 1; i < RTE_DIM(rte_crypto_aead_algorithm_strings); i++) {
210 if (strcmp(algo_string, rte_crypto_aead_algorithm_strings[i]) == 0) {
211 *algo_enum = (enum rte_crypto_aead_algorithm) i;
221 * The crypto auth operation strings identifiers.
222 * It could be used in application command line.
225 rte_crypto_auth_operation_strings[] = {
226 [RTE_CRYPTO_AUTH_OP_VERIFY] = "verify",
227 [RTE_CRYPTO_AUTH_OP_GENERATE] = "generate"
230 const struct rte_cryptodev_symmetric_capability *
231 rte_cryptodev_sym_capability_get(uint8_t dev_id,
232 const struct rte_cryptodev_sym_capability_idx *idx)
234 const struct rte_cryptodev_capabilities *capability;
235 struct rte_cryptodev_info dev_info;
238 rte_cryptodev_info_get(dev_id, &dev_info);
240 while ((capability = &dev_info.capabilities[i++])->op !=
241 RTE_CRYPTO_OP_TYPE_UNDEFINED) {
242 if (capability->op != RTE_CRYPTO_OP_TYPE_SYMMETRIC)
245 if (capability->sym.xform_type != idx->type)
248 if (idx->type == RTE_CRYPTO_SYM_XFORM_AUTH &&
249 capability->sym.auth.algo == idx->algo.auth)
250 return &capability->sym;
252 if (idx->type == RTE_CRYPTO_SYM_XFORM_CIPHER &&
253 capability->sym.cipher.algo == idx->algo.cipher)
254 return &capability->sym;
256 if (idx->type == RTE_CRYPTO_SYM_XFORM_AEAD &&
257 capability->sym.aead.algo == idx->algo.aead)
258 return &capability->sym;
265 #define param_range_check(x, y) \
266 (((x < y.min) || (x > y.max)) || \
267 (y.increment != 0 && (x % y.increment) != 0))
270 rte_cryptodev_sym_capability_check_cipher(
271 const struct rte_cryptodev_symmetric_capability *capability,
272 uint16_t key_size, uint16_t iv_size)
274 if (param_range_check(key_size, capability->cipher.key_size))
277 if (param_range_check(iv_size, capability->cipher.iv_size))
284 rte_cryptodev_sym_capability_check_auth(
285 const struct rte_cryptodev_symmetric_capability *capability,
286 uint16_t key_size, uint16_t digest_size, uint16_t iv_size)
288 if (param_range_check(key_size, capability->auth.key_size))
291 if (param_range_check(digest_size, capability->auth.digest_size))
294 if (param_range_check(iv_size, capability->auth.iv_size))
301 rte_cryptodev_sym_capability_check_aead(
302 const struct rte_cryptodev_symmetric_capability *capability,
303 uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
306 if (param_range_check(key_size, capability->aead.key_size))
309 if (param_range_check(digest_size, capability->aead.digest_size))
312 if (param_range_check(aad_size, capability->aead.aad_size))
315 if (param_range_check(iv_size, capability->aead.iv_size))
322 rte_cryptodev_get_feature_name(uint64_t flag)
325 case RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO:
326 return "SYMMETRIC_CRYPTO";
327 case RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO:
328 return "ASYMMETRIC_CRYPTO";
329 case RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING:
330 return "SYM_OPERATION_CHAINING";
331 case RTE_CRYPTODEV_FF_CPU_SSE:
333 case RTE_CRYPTODEV_FF_CPU_AVX:
335 case RTE_CRYPTODEV_FF_CPU_AVX2:
337 case RTE_CRYPTODEV_FF_CPU_AESNI:
339 case RTE_CRYPTODEV_FF_HW_ACCELERATED:
340 return "HW_ACCELERATED";
341 case RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER:
342 return "MBUF_SCATTER_GATHER";
343 case RTE_CRYPTODEV_FF_CPU_NEON:
345 case RTE_CRYPTODEV_FF_CPU_ARM_CE:
352 struct rte_cryptodev *
353 rte_cryptodev_pmd_get_dev(uint8_t dev_id)
355 return &rte_cryptodev_globals->devs[dev_id];
358 struct rte_cryptodev *
359 rte_cryptodev_pmd_get_named_dev(const char *name)
361 struct rte_cryptodev *dev;
367 for (i = 0; i < rte_cryptodev_globals->max_devs; i++) {
368 dev = &rte_cryptodev_globals->devs[i];
370 if ((dev->attached == RTE_CRYPTODEV_ATTACHED) &&
371 (strcmp(dev->data->name, name) == 0))
379 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
381 struct rte_cryptodev *dev = NULL;
383 if (dev_id >= rte_cryptodev_globals->nb_devs)
386 dev = rte_cryptodev_pmd_get_dev(dev_id);
387 if (dev->attached != RTE_CRYPTODEV_ATTACHED)
395 rte_cryptodev_get_dev_id(const char *name)
402 for (i = 0; i < rte_cryptodev_globals->nb_devs; i++)
403 if ((strcmp(rte_cryptodev_globals->devs[i].data->name, name)
405 (rte_cryptodev_globals->devs[i].attached ==
406 RTE_CRYPTODEV_ATTACHED))
413 rte_cryptodev_count(void)
415 return rte_cryptodev_globals->nb_devs;
419 rte_cryptodev_device_count_by_driver(uint8_t driver_id)
421 uint8_t i, dev_count = 0;
423 for (i = 0; i < rte_cryptodev_globals->max_devs; i++)
424 if (rte_cryptodev_globals->devs[i].driver_id == driver_id &&
425 rte_cryptodev_globals->devs[i].attached ==
426 RTE_CRYPTODEV_ATTACHED)
433 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
436 uint8_t i, count = 0;
437 struct rte_cryptodev *devs = rte_cryptodev_globals->devs;
438 uint8_t max_devs = rte_cryptodev_globals->max_devs;
440 for (i = 0; i < max_devs && count < nb_devices; i++) {
442 if (devs[i].attached == RTE_CRYPTODEV_ATTACHED) {
445 cmp = strncmp(devs[i].device->driver->name,
447 strlen(driver_name));
450 devices[count++] = devs[i].data->dev_id;
458 rte_cryptodev_get_sec_ctx(uint8_t dev_id)
460 if (rte_crypto_devices[dev_id].feature_flags &
461 RTE_CRYPTODEV_FF_SECURITY)
462 return rte_crypto_devices[dev_id].security_ctx;
468 rte_cryptodev_socket_id(uint8_t dev_id)
470 struct rte_cryptodev *dev;
472 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
475 dev = rte_cryptodev_pmd_get_dev(dev_id);
477 return dev->data->socket_id;
481 rte_cryptodev_data_alloc(uint8_t dev_id, struct rte_cryptodev_data **data,
484 char mz_name[RTE_CRYPTODEV_NAME_MAX_LEN];
485 const struct rte_memzone *mz;
488 /* generate memzone name */
489 n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
490 if (n >= (int)sizeof(mz_name))
493 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
494 mz = rte_memzone_reserve(mz_name,
495 sizeof(struct rte_cryptodev_data),
498 mz = rte_memzone_lookup(mz_name);
504 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
505 memset(*data, 0, sizeof(struct rte_cryptodev_data));
511 rte_cryptodev_find_free_device_index(void)
515 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) {
516 if (rte_crypto_devices[dev_id].attached ==
517 RTE_CRYPTODEV_DETACHED)
520 return RTE_CRYPTO_MAX_DEVS;
523 struct rte_cryptodev *
524 rte_cryptodev_pmd_allocate(const char *name, int socket_id)
526 struct rte_cryptodev *cryptodev;
529 if (rte_cryptodev_pmd_get_named_dev(name) != NULL) {
530 CDEV_LOG_ERR("Crypto device with name %s already "
535 dev_id = rte_cryptodev_find_free_device_index();
536 if (dev_id == RTE_CRYPTO_MAX_DEVS) {
537 CDEV_LOG_ERR("Reached maximum number of crypto devices");
541 cryptodev = rte_cryptodev_pmd_get_dev(dev_id);
543 if (cryptodev->data == NULL) {
544 struct rte_cryptodev_data *cryptodev_data =
545 cryptodev_globals.data[dev_id];
547 int retval = rte_cryptodev_data_alloc(dev_id, &cryptodev_data,
550 if (retval < 0 || cryptodev_data == NULL)
553 cryptodev->data = cryptodev_data;
555 snprintf(cryptodev->data->name, RTE_CRYPTODEV_NAME_MAX_LEN,
558 cryptodev->data->dev_id = dev_id;
559 cryptodev->data->socket_id = socket_id;
560 cryptodev->data->dev_started = 0;
562 /* init user callbacks */
563 TAILQ_INIT(&(cryptodev->link_intr_cbs));
565 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
567 cryptodev_globals.nb_devs++;
574 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
578 if (cryptodev == NULL)
581 /* Close device only if device operations have been set */
582 if (cryptodev->dev_ops) {
583 ret = rte_cryptodev_close(cryptodev->data->dev_id);
588 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
589 cryptodev_globals.nb_devs--;
594 rte_cryptodev_queue_pair_count(uint8_t dev_id)
596 struct rte_cryptodev *dev;
598 dev = &rte_crypto_devices[dev_id];
599 return dev->data->nb_queue_pairs;
603 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
606 struct rte_cryptodev_info dev_info;
610 if ((dev == NULL) || (nb_qpairs < 1)) {
611 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
616 CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
617 nb_qpairs, dev->data->dev_id);
619 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
621 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
622 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
624 if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
625 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
626 nb_qpairs, dev->data->dev_id);
630 if (dev->data->queue_pairs == NULL) { /* first time configuration */
631 dev->data->queue_pairs = rte_zmalloc_socket(
632 "cryptodev->queue_pairs",
633 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
634 RTE_CACHE_LINE_SIZE, socket_id);
636 if (dev->data->queue_pairs == NULL) {
637 dev->data->nb_queue_pairs = 0;
638 CDEV_LOG_ERR("failed to get memory for qp meta data, "
643 } else { /* re-configure */
645 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
647 qp = dev->data->queue_pairs;
649 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
652 for (i = nb_qpairs; i < old_nb_queues; i++) {
653 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
658 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
659 RTE_CACHE_LINE_SIZE);
661 CDEV_LOG_ERR("failed to realloc qp meta data,"
662 " nb_queues %u", nb_qpairs);
666 if (nb_qpairs > old_nb_queues) {
667 uint16_t new_qs = nb_qpairs - old_nb_queues;
669 memset(qp + old_nb_queues, 0,
670 sizeof(qp[0]) * new_qs);
673 dev->data->queue_pairs = qp;
676 dev->data->nb_queue_pairs = nb_qpairs;
681 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id)
683 struct rte_cryptodev *dev;
685 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
686 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
690 dev = &rte_crypto_devices[dev_id];
691 if (queue_pair_id >= dev->data->nb_queue_pairs) {
692 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
696 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_start, -ENOTSUP);
698 return dev->dev_ops->queue_pair_start(dev, queue_pair_id);
703 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id)
705 struct rte_cryptodev *dev;
707 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
708 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
712 dev = &rte_crypto_devices[dev_id];
713 if (queue_pair_id >= dev->data->nb_queue_pairs) {
714 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
718 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_stop, -ENOTSUP);
720 return dev->dev_ops->queue_pair_stop(dev, queue_pair_id);
725 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
727 struct rte_cryptodev *dev;
730 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
731 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
735 dev = &rte_crypto_devices[dev_id];
737 if (dev->data->dev_started) {
739 "device %d must be stopped to allow configuration", dev_id);
743 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
745 /* Setup new number of queue pairs and reconfigure device. */
746 diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
749 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
754 return (*dev->dev_ops->dev_configure)(dev, config);
759 rte_cryptodev_start(uint8_t dev_id)
761 struct rte_cryptodev *dev;
764 CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
766 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
767 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
771 dev = &rte_crypto_devices[dev_id];
773 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
775 if (dev->data->dev_started != 0) {
776 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
781 diag = (*dev->dev_ops->dev_start)(dev);
783 dev->data->dev_started = 1;
791 rte_cryptodev_stop(uint8_t dev_id)
793 struct rte_cryptodev *dev;
795 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
796 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
800 dev = &rte_crypto_devices[dev_id];
802 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
804 if (dev->data->dev_started == 0) {
805 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
810 (*dev->dev_ops->dev_stop)(dev);
811 dev->data->dev_started = 0;
815 rte_cryptodev_close(uint8_t dev_id)
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 /* Device must be stopped before it can be closed */
828 if (dev->data->dev_started == 1) {
829 CDEV_LOG_ERR("Device %u must be stopped before closing",
834 /* We can't close the device if there are outstanding sessions in use */
835 if (dev->data->session_pool != NULL) {
836 if (!rte_mempool_full(dev->data->session_pool)) {
837 CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
838 "has sessions still in use, free "
839 "all sessions before calling close",
845 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
846 retval = (*dev->dev_ops->dev_close)(dev);
855 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
856 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id,
857 struct rte_mempool *session_pool)
860 struct rte_cryptodev *dev;
862 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
863 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
867 dev = &rte_crypto_devices[dev_id];
868 if (queue_pair_id >= dev->data->nb_queue_pairs) {
869 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
873 if (dev->data->dev_started) {
875 "device %d must be stopped to allow configuration", dev_id);
879 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
881 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
882 socket_id, session_pool);
887 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
889 struct rte_cryptodev *dev;
891 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
892 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
897 CDEV_LOG_ERR("Invalid stats ptr");
901 dev = &rte_crypto_devices[dev_id];
902 memset(stats, 0, sizeof(*stats));
904 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
905 (*dev->dev_ops->stats_get)(dev, stats);
910 rte_cryptodev_stats_reset(uint8_t dev_id)
912 struct rte_cryptodev *dev;
914 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
915 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
919 dev = &rte_crypto_devices[dev_id];
921 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
922 (*dev->dev_ops->stats_reset)(dev);
927 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
929 struct rte_cryptodev *dev;
931 if (dev_id >= cryptodev_globals.nb_devs) {
932 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
936 dev = &rte_crypto_devices[dev_id];
938 memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
940 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
941 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
943 dev_info->driver_name = dev->device->driver->name;
948 rte_cryptodev_callback_register(uint8_t dev_id,
949 enum rte_cryptodev_event_type event,
950 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
952 struct rte_cryptodev *dev;
953 struct rte_cryptodev_callback *user_cb;
958 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
959 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
963 dev = &rte_crypto_devices[dev_id];
964 rte_spinlock_lock(&rte_cryptodev_cb_lock);
966 TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
967 if (user_cb->cb_fn == cb_fn &&
968 user_cb->cb_arg == cb_arg &&
969 user_cb->event == event) {
974 /* create a new callback. */
975 if (user_cb == NULL) {
976 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
977 sizeof(struct rte_cryptodev_callback), 0);
978 if (user_cb != NULL) {
979 user_cb->cb_fn = cb_fn;
980 user_cb->cb_arg = cb_arg;
981 user_cb->event = event;
982 TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
986 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
987 return (user_cb == NULL) ? -ENOMEM : 0;
991 rte_cryptodev_callback_unregister(uint8_t dev_id,
992 enum rte_cryptodev_event_type event,
993 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
996 struct rte_cryptodev *dev;
997 struct rte_cryptodev_callback *cb, *next;
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];
1008 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1011 for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
1013 next = TAILQ_NEXT(cb, next);
1015 if (cb->cb_fn != cb_fn || cb->event != event ||
1016 (cb->cb_arg != (void *)-1 &&
1017 cb->cb_arg != cb_arg))
1021 * if this callback is not executing right now,
1024 if (cb->active == 0) {
1025 TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
1032 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1037 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
1038 enum rte_cryptodev_event_type event)
1040 struct rte_cryptodev_callback *cb_lst;
1041 struct rte_cryptodev_callback dev_cb;
1043 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1044 TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
1045 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
1049 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1050 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
1052 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1055 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1060 rte_cryptodev_sym_session_init(uint8_t dev_id,
1061 struct rte_cryptodev_sym_session *sess,
1062 struct rte_crypto_sym_xform *xforms,
1063 struct rte_mempool *mp)
1065 struct rte_cryptodev *dev;
1069 dev = rte_cryptodev_pmd_get_dev(dev_id);
1071 if (sess == NULL || xforms == NULL || dev == NULL)
1074 index = dev->driver_id;
1076 if (sess->sess_private_data[index] == NULL) {
1077 ret = dev->dev_ops->session_configure(dev, xforms, sess, mp);
1080 "dev_id %d failed to configure session details",
1089 struct rte_cryptodev_sym_session *
1090 rte_cryptodev_sym_session_create(struct rte_mempool *mp)
1092 struct rte_cryptodev_sym_session *sess;
1094 /* Allocate a session structure from the session pool */
1095 if (rte_mempool_get(mp, (void *)&sess)) {
1096 CDEV_LOG_ERR("couldn't get object from session mempool");
1100 /* Clear device session pointer */
1101 memset(sess, 0, (sizeof(void *) * nb_drivers));
1107 rte_cryptodev_queue_pair_attach_sym_session(uint8_t dev_id, uint16_t qp_id,
1108 struct rte_cryptodev_sym_session *sess)
1110 struct rte_cryptodev *dev;
1112 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1113 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1117 dev = &rte_crypto_devices[dev_id];
1119 /* The API is optional, not returning error if driver do not suuport */
1120 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_attach_session, 0);
1122 void *sess_priv = get_session_private_data(sess, dev->driver_id);
1124 if (dev->dev_ops->qp_attach_session(dev, qp_id, sess_priv)) {
1125 CDEV_LOG_ERR("dev_id %d failed to attach qp: %d with session",
1134 rte_cryptodev_queue_pair_detach_sym_session(uint8_t dev_id, uint16_t qp_id,
1135 struct rte_cryptodev_sym_session *sess)
1137 struct rte_cryptodev *dev;
1139 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1140 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1144 dev = &rte_crypto_devices[dev_id];
1146 /* The API is optional, not returning error if driver do not suuport */
1147 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_detach_session, 0);
1149 void *sess_priv = get_session_private_data(sess, dev->driver_id);
1151 if (dev->dev_ops->qp_detach_session(dev, qp_id, sess_priv)) {
1152 CDEV_LOG_ERR("dev_id %d failed to detach qp: %d from session",
1161 rte_cryptodev_sym_session_clear(uint8_t dev_id,
1162 struct rte_cryptodev_sym_session *sess)
1164 struct rte_cryptodev *dev;
1166 dev = rte_cryptodev_pmd_get_dev(dev_id);
1168 if (dev == NULL || sess == NULL)
1171 dev->dev_ops->session_clear(dev, sess);
1177 rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess)
1181 struct rte_mempool *sess_mp;
1186 /* Check that all device private data has been freed */
1187 for (i = 0; i < nb_drivers; i++) {
1188 sess_priv = get_session_private_data(sess, i);
1189 if (sess_priv != NULL)
1193 /* Return session to mempool */
1194 sess_mp = rte_mempool_from_obj(sess);
1195 rte_mempool_put(sess_mp, sess);
1201 rte_cryptodev_get_header_session_size(void)
1204 * Header contains pointers to the private data
1205 * of all registered drivers
1207 return (sizeof(void *) * nb_drivers);
1211 rte_cryptodev_get_private_session_size(uint8_t dev_id)
1213 struct rte_cryptodev *dev;
1214 unsigned int header_size = sizeof(void *) * nb_drivers;
1215 unsigned int priv_sess_size;
1217 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
1220 dev = rte_cryptodev_pmd_get_dev(dev_id);
1222 if (*dev->dev_ops->session_get_size == NULL)
1225 priv_sess_size = (*dev->dev_ops->session_get_size)(dev);
1228 * If size is less than session header size,
1229 * return the latter, as this guarantees that
1230 * sessionless operations will work
1232 if (priv_sess_size < header_size)
1235 return priv_sess_size;
1239 /** Initialise rte_crypto_op mempool element */
1241 rte_crypto_op_init(struct rte_mempool *mempool,
1244 __rte_unused unsigned i)
1246 struct rte_crypto_op *op = _op_data;
1247 enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
1249 memset(_op_data, 0, mempool->elt_size);
1251 __rte_crypto_op_reset(op, type);
1253 op->phys_addr = rte_mem_virt2iova(_op_data);
1254 op->mempool = mempool;
1258 struct rte_mempool *
1259 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
1260 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
1263 struct rte_crypto_op_pool_private *priv;
1265 unsigned elt_size = sizeof(struct rte_crypto_op) +
1266 sizeof(struct rte_crypto_sym_op) +
1269 /* lookup mempool in case already allocated */
1270 struct rte_mempool *mp = rte_mempool_lookup(name);
1273 priv = (struct rte_crypto_op_pool_private *)
1274 rte_mempool_get_priv(mp);
1276 if (mp->elt_size != elt_size ||
1277 mp->cache_size < cache_size ||
1278 mp->size < nb_elts ||
1279 priv->priv_size < priv_size) {
1281 CDEV_LOG_ERR("Mempool %s already exists but with "
1282 "incompatible parameters", name);
1288 mp = rte_mempool_create(
1293 sizeof(struct rte_crypto_op_pool_private),
1302 CDEV_LOG_ERR("Failed to create mempool %s", name);
1306 priv = (struct rte_crypto_op_pool_private *)
1307 rte_mempool_get_priv(mp);
1309 priv->priv_size = priv_size;
1316 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix)
1318 struct rte_cryptodev *dev = NULL;
1324 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
1325 int ret = snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
1326 "%s_%u", dev_name_prefix, i);
1331 dev = rte_cryptodev_pmd_get_named_dev(name);
1339 TAILQ_HEAD(cryptodev_driver_list, cryptodev_driver);
1341 static struct cryptodev_driver_list cryptodev_driver_list =
1342 TAILQ_HEAD_INITIALIZER(cryptodev_driver_list);
1345 rte_cryptodev_driver_id_get(const char *name)
1347 struct cryptodev_driver *driver;
1348 const char *driver_name;
1351 RTE_LOG(DEBUG, CRYPTODEV, "name pointer NULL");
1355 TAILQ_FOREACH(driver, &cryptodev_driver_list, next) {
1356 driver_name = driver->driver->name;
1357 if (strncmp(driver_name, name, strlen(driver_name)) == 0)
1364 rte_cryptodev_name_get(uint8_t dev_id)
1366 struct rte_cryptodev *dev = rte_cryptodev_pmd_get_dev(dev_id);
1371 return dev->data->name;
1375 rte_cryptodev_driver_name_get(uint8_t driver_id)
1377 struct cryptodev_driver *driver;
1379 TAILQ_FOREACH(driver, &cryptodev_driver_list, next)
1380 if (driver->id == driver_id)
1381 return driver->driver->name;
1386 rte_cryptodev_allocate_driver(struct cryptodev_driver *crypto_drv,
1387 const struct rte_driver *drv)
1389 crypto_drv->driver = drv;
1390 crypto_drv->id = nb_drivers;
1392 TAILQ_INSERT_TAIL(&cryptodev_driver_list, crypto_drv, next);
1394 return nb_drivers++;