4 * Copyright(c) 2015-2017 Intel Corporation. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
16 * * Neither the name of Intel Corporation nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 #include <sys/types.h>
34 #include <sys/queue.h>
43 #include <netinet/in.h>
45 #include <rte_byteorder.h>
47 #include <rte_debug.h>
49 #include <rte_interrupts.h>
51 #include <rte_memory.h>
52 #include <rte_memcpy.h>
53 #include <rte_memzone.h>
54 #include <rte_launch.h>
55 #include <rte_tailq.h>
57 #include <rte_per_lcore.h>
58 #include <rte_lcore.h>
59 #include <rte_atomic.h>
60 #include <rte_branch_prediction.h>
61 #include <rte_common.h>
62 #include <rte_mempool.h>
63 #include <rte_malloc.h>
65 #include <rte_errno.h>
66 #include <rte_spinlock.h>
67 #include <rte_string_fns.h>
69 #include "rte_crypto.h"
70 #include "rte_cryptodev.h"
71 #include "rte_cryptodev_pmd.h"
73 struct rte_cryptodev rte_crypto_devices[RTE_CRYPTO_MAX_DEVS];
75 struct rte_cryptodev *rte_cryptodevs = &rte_crypto_devices[0];
77 static struct rte_cryptodev_global cryptodev_globals = {
78 .devs = &rte_crypto_devices[0],
81 .max_devs = RTE_CRYPTO_MAX_DEVS
84 struct rte_cryptodev_global *rte_cryptodev_globals = &cryptodev_globals;
86 /* spinlock for crypto device callbacks */
87 static rte_spinlock_t rte_cryptodev_cb_lock = RTE_SPINLOCK_INITIALIZER;
91 * The user application callback description.
93 * It contains callback address to be registered by user application,
94 * the pointer to the parameters for callback, and the event type.
96 struct rte_cryptodev_callback {
97 TAILQ_ENTRY(rte_cryptodev_callback) next; /**< Callbacks list */
98 rte_cryptodev_cb_fn cb_fn; /**< Callback address */
99 void *cb_arg; /**< Parameter for callback */
100 enum rte_cryptodev_event_type event; /**< Interrupt event type */
101 uint32_t active; /**< Callback is executing */
104 #define RTE_CRYPTODEV_VDEV_NAME ("name")
105 #define RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG ("max_nb_queue_pairs")
106 #define RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG ("max_nb_sessions")
107 #define RTE_CRYPTODEV_VDEV_SOCKET_ID ("socket_id")
109 static const char *cryptodev_vdev_valid_params[] = {
110 RTE_CRYPTODEV_VDEV_NAME,
111 RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
112 RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
113 RTE_CRYPTODEV_VDEV_SOCKET_ID
117 * The crypto cipher algorithm strings identifiers.
118 * It could be used in application command line.
121 rte_crypto_cipher_algorithm_strings[] = {
122 [RTE_CRYPTO_CIPHER_3DES_CBC] = "3des-cbc",
123 [RTE_CRYPTO_CIPHER_3DES_ECB] = "3des-ecb",
124 [RTE_CRYPTO_CIPHER_3DES_CTR] = "3des-ctr",
126 [RTE_CRYPTO_CIPHER_AES_CBC] = "aes-cbc",
127 [RTE_CRYPTO_CIPHER_AES_CCM] = "aes-ccm",
128 [RTE_CRYPTO_CIPHER_AES_CTR] = "aes-ctr",
129 [RTE_CRYPTO_CIPHER_AES_DOCSISBPI] = "aes-docsisbpi",
130 [RTE_CRYPTO_CIPHER_AES_ECB] = "aes-ecb",
131 [RTE_CRYPTO_CIPHER_AES_GCM] = "aes-gcm",
132 [RTE_CRYPTO_CIPHER_AES_F8] = "aes-f8",
133 [RTE_CRYPTO_CIPHER_AES_XTS] = "aes-xts",
135 [RTE_CRYPTO_CIPHER_ARC4] = "arc4",
137 [RTE_CRYPTO_CIPHER_DES_CBC] = "des-cbc",
138 [RTE_CRYPTO_CIPHER_DES_DOCSISBPI] = "des-docsisbpi",
140 [RTE_CRYPTO_CIPHER_NULL] = "null",
142 [RTE_CRYPTO_CIPHER_KASUMI_F8] = "kasumi-f8",
143 [RTE_CRYPTO_CIPHER_SNOW3G_UEA2] = "snow3g-uea2",
144 [RTE_CRYPTO_CIPHER_ZUC_EEA3] = "zuc-eea3"
148 * The crypto cipher operation strings identifiers.
149 * It could be used in application command line.
152 rte_crypto_cipher_operation_strings[] = {
153 [RTE_CRYPTO_CIPHER_OP_ENCRYPT] = "encrypt",
154 [RTE_CRYPTO_CIPHER_OP_DECRYPT] = "decrypt"
158 * The crypto auth algorithm strings identifiers.
159 * It could be used in application command line.
162 rte_crypto_auth_algorithm_strings[] = {
163 [RTE_CRYPTO_AUTH_AES_CBC_MAC] = "aes-cbc-mac",
164 [RTE_CRYPTO_AUTH_AES_CCM] = "aes-ccm",
165 [RTE_CRYPTO_AUTH_AES_CMAC] = "aes-cmac",
166 [RTE_CRYPTO_AUTH_AES_GCM] = "aes-gcm",
167 [RTE_CRYPTO_AUTH_AES_GMAC] = "aes-gmac",
168 [RTE_CRYPTO_AUTH_AES_XCBC_MAC] = "aes-xcbc-mac",
170 [RTE_CRYPTO_AUTH_MD5] = "md5",
171 [RTE_CRYPTO_AUTH_MD5_HMAC] = "md5-hmac",
173 [RTE_CRYPTO_AUTH_NULL] = "null",
175 [RTE_CRYPTO_AUTH_SHA1] = "sha1",
176 [RTE_CRYPTO_AUTH_SHA1_HMAC] = "sha1-hmac",
178 [RTE_CRYPTO_AUTH_SHA224] = "sha2-224",
179 [RTE_CRYPTO_AUTH_SHA224_HMAC] = "sha2-224-hmac",
180 [RTE_CRYPTO_AUTH_SHA256] = "sha2-256",
181 [RTE_CRYPTO_AUTH_SHA256_HMAC] = "sha2-256-hmac",
182 [RTE_CRYPTO_AUTH_SHA384] = "sha2-384",
183 [RTE_CRYPTO_AUTH_SHA384_HMAC] = "sha2-384-hmac",
184 [RTE_CRYPTO_AUTH_SHA512] = "sha2-512",
185 [RTE_CRYPTO_AUTH_SHA512_HMAC] = "sha2-512-hmac",
187 [RTE_CRYPTO_AUTH_KASUMI_F9] = "kasumi-f9",
188 [RTE_CRYPTO_AUTH_SNOW3G_UIA2] = "snow3g-uia2",
189 [RTE_CRYPTO_AUTH_ZUC_EIA3] = "zuc-eia3"
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 * The crypto auth operation strings identifiers.
228 * It could be used in application command line.
231 rte_crypto_auth_operation_strings[] = {
232 [RTE_CRYPTO_AUTH_OP_VERIFY] = "verify",
233 [RTE_CRYPTO_AUTH_OP_GENERATE] = "generate"
236 /** Parse integer from integer argument */
238 parse_integer_arg(const char *key __rte_unused,
239 const char *value, void *extra_args)
245 CDEV_LOG_ERR("Argument has to be positive.");
254 parse_name_arg(const char *key __rte_unused,
255 const char *value, void *extra_args)
257 struct rte_crypto_vdev_init_params *params = extra_args;
259 if (strlen(value) >= RTE_CRYPTODEV_NAME_MAX_LEN - 1) {
260 CDEV_LOG_ERR("Invalid name %s, should be less than "
262 RTE_CRYPTODEV_NAME_MAX_LEN - 1);
266 strncpy(params->name, value, RTE_CRYPTODEV_NAME_MAX_LEN);
272 rte_cryptodev_parse_vdev_init_params(struct rte_crypto_vdev_init_params *params,
273 const char *input_args)
275 struct rte_kvargs *kvlist = NULL;
282 kvlist = rte_kvargs_parse(input_args,
283 cryptodev_vdev_valid_params);
287 ret = rte_kvargs_process(kvlist,
288 RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
290 ¶ms->max_nb_queue_pairs);
294 ret = rte_kvargs_process(kvlist,
295 RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
297 ¶ms->max_nb_sessions);
301 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SOCKET_ID,
307 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_NAME,
315 rte_kvargs_free(kvlist);
319 const struct rte_cryptodev_symmetric_capability *
320 rte_cryptodev_sym_capability_get(uint8_t dev_id,
321 const struct rte_cryptodev_sym_capability_idx *idx)
323 const struct rte_cryptodev_capabilities *capability;
324 struct rte_cryptodev_info dev_info;
327 rte_cryptodev_info_get(dev_id, &dev_info);
329 while ((capability = &dev_info.capabilities[i++])->op !=
330 RTE_CRYPTO_OP_TYPE_UNDEFINED) {
331 if (capability->op != RTE_CRYPTO_OP_TYPE_SYMMETRIC)
334 if (capability->sym.xform_type != idx->type)
337 if (idx->type == RTE_CRYPTO_SYM_XFORM_AUTH &&
338 capability->sym.auth.algo == idx->algo.auth)
339 return &capability->sym;
341 if (idx->type == RTE_CRYPTO_SYM_XFORM_CIPHER &&
342 capability->sym.cipher.algo == idx->algo.cipher)
343 return &capability->sym;
350 #define param_range_check(x, y) \
351 (((x < y.min) || (x > y.max)) || \
352 (y.increment != 0 && (x % y.increment) != 0))
355 rte_cryptodev_sym_capability_check_cipher(
356 const struct rte_cryptodev_symmetric_capability *capability,
357 uint16_t key_size, uint16_t iv_size)
359 if (param_range_check(key_size, capability->cipher.key_size))
362 if (param_range_check(iv_size, capability->cipher.iv_size))
369 rte_cryptodev_sym_capability_check_auth(
370 const struct rte_cryptodev_symmetric_capability *capability,
371 uint16_t key_size, uint16_t digest_size, uint16_t aad_size)
373 if (param_range_check(key_size, capability->auth.key_size))
376 if (param_range_check(digest_size, capability->auth.digest_size))
379 if (param_range_check(aad_size, capability->auth.aad_size))
387 rte_cryptodev_get_feature_name(uint64_t flag)
390 case RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO:
391 return "SYMMETRIC_CRYPTO";
392 case RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO:
393 return "ASYMMETRIC_CRYPTO";
394 case RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING:
395 return "SYM_OPERATION_CHAINING";
396 case RTE_CRYPTODEV_FF_CPU_SSE:
398 case RTE_CRYPTODEV_FF_CPU_AVX:
400 case RTE_CRYPTODEV_FF_CPU_AVX2:
402 case RTE_CRYPTODEV_FF_CPU_AESNI:
404 case RTE_CRYPTODEV_FF_HW_ACCELERATED:
405 return "HW_ACCELERATED";
406 case RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER:
407 return "MBUF_SCATTER_GATHER";
408 case RTE_CRYPTODEV_FF_CPU_NEON:
410 case RTE_CRYPTODEV_FF_CPU_ARM_CE:
418 rte_cryptodev_create_vdev(const char *name, const char *args)
420 return rte_vdev_init(name, args);
423 struct rte_cryptodev *
424 rte_cryptodev_pmd_get_dev(uint8_t dev_id)
426 return &rte_cryptodev_globals->devs[dev_id];
429 struct rte_cryptodev *
430 rte_cryptodev_pmd_get_named_dev(const char *name)
432 struct rte_cryptodev *dev;
438 for (i = 0; i < rte_cryptodev_globals->max_devs; i++) {
439 dev = &rte_cryptodev_globals->devs[i];
441 if ((dev->attached == RTE_CRYPTODEV_ATTACHED) &&
442 (strcmp(dev->data->name, name) == 0))
450 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
452 struct rte_cryptodev *dev = NULL;
454 if (dev_id >= rte_cryptodev_globals->nb_devs)
457 dev = rte_cryptodev_pmd_get_dev(dev_id);
458 if (dev->attached != RTE_CRYPTODEV_ATTACHED)
466 rte_cryptodev_get_dev_id(const char *name)
473 for (i = 0; i < rte_cryptodev_globals->nb_devs; i++)
474 if ((strcmp(rte_cryptodev_globals->devs[i].data->name, name)
476 (rte_cryptodev_globals->devs[i].attached ==
477 RTE_CRYPTODEV_ATTACHED))
484 rte_cryptodev_count(void)
486 return rte_cryptodev_globals->nb_devs;
490 rte_cryptodev_count_devtype(enum rte_cryptodev_type type)
492 uint8_t i, dev_count = 0;
494 for (i = 0; i < rte_cryptodev_globals->max_devs; i++)
495 if (rte_cryptodev_globals->devs[i].dev_type == type &&
496 rte_cryptodev_globals->devs[i].attached ==
497 RTE_CRYPTODEV_ATTACHED)
504 rte_cryptodev_devices_get(const char *dev_name, uint8_t *devices,
507 uint8_t i, count = 0;
508 struct rte_cryptodev *devs = rte_cryptodev_globals->devs;
509 uint8_t max_devs = rte_cryptodev_globals->max_devs;
511 for (i = 0; i < max_devs && count < nb_devices; i++) {
513 if (devs[i].attached == RTE_CRYPTODEV_ATTACHED) {
514 const struct rte_cryptodev_driver *drv = devs[i].driver;
518 cmp = strncmp(drv->pci_drv.driver.name,
519 dev_name, strlen(dev_name));
521 cmp = strncmp(devs[i].data->name,
522 dev_name, strlen(dev_name));
525 devices[count++] = devs[i].data->dev_id;
533 rte_cryptodev_socket_id(uint8_t dev_id)
535 struct rte_cryptodev *dev;
537 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
540 dev = rte_cryptodev_pmd_get_dev(dev_id);
542 return dev->data->socket_id;
546 rte_cryptodev_data_alloc(uint8_t dev_id, struct rte_cryptodev_data **data,
549 char mz_name[RTE_CRYPTODEV_NAME_MAX_LEN];
550 const struct rte_memzone *mz;
553 /* generate memzone name */
554 n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
555 if (n >= (int)sizeof(mz_name))
558 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
559 mz = rte_memzone_reserve(mz_name,
560 sizeof(struct rte_cryptodev_data),
563 mz = rte_memzone_lookup(mz_name);
569 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
570 memset(*data, 0, sizeof(struct rte_cryptodev_data));
576 rte_cryptodev_find_free_device_index(void)
580 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) {
581 if (rte_crypto_devices[dev_id].attached ==
582 RTE_CRYPTODEV_DETACHED)
585 return RTE_CRYPTO_MAX_DEVS;
588 struct rte_cryptodev *
589 rte_cryptodev_pmd_allocate(const char *name, int socket_id)
591 struct rte_cryptodev *cryptodev;
594 if (rte_cryptodev_pmd_get_named_dev(name) != NULL) {
595 CDEV_LOG_ERR("Crypto device with name %s already "
600 dev_id = rte_cryptodev_find_free_device_index();
601 if (dev_id == RTE_CRYPTO_MAX_DEVS) {
602 CDEV_LOG_ERR("Reached maximum number of crypto devices");
606 cryptodev = rte_cryptodev_pmd_get_dev(dev_id);
608 if (cryptodev->data == NULL) {
609 struct rte_cryptodev_data *cryptodev_data =
610 cryptodev_globals.data[dev_id];
612 int retval = rte_cryptodev_data_alloc(dev_id, &cryptodev_data,
615 if (retval < 0 || cryptodev_data == NULL)
618 cryptodev->data = cryptodev_data;
620 snprintf(cryptodev->data->name, RTE_CRYPTODEV_NAME_MAX_LEN,
623 cryptodev->data->dev_id = dev_id;
624 cryptodev->data->socket_id = socket_id;
625 cryptodev->data->dev_started = 0;
627 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
629 cryptodev_globals.nb_devs++;
636 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
640 if (cryptodev == NULL)
643 ret = rte_cryptodev_close(cryptodev->data->dev_id);
647 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
648 cryptodev_globals.nb_devs--;
652 struct rte_cryptodev *
653 rte_cryptodev_pmd_virtual_dev_init(const char *name, size_t dev_private_size,
656 struct rte_cryptodev *cryptodev;
658 /* allocate device structure */
659 cryptodev = rte_cryptodev_pmd_allocate(name, socket_id);
660 if (cryptodev == NULL)
663 /* allocate private device structure */
664 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
665 cryptodev->data->dev_private =
666 rte_zmalloc_socket("cryptodev device private",
671 if (cryptodev->data->dev_private == NULL)
672 rte_panic("Cannot allocate memzone for private device"
676 /* initialise user call-back tail queue */
677 TAILQ_INIT(&(cryptodev->link_intr_cbs));
683 rte_cryptodev_pci_probe(struct rte_pci_driver *pci_drv,
684 struct rte_pci_device *pci_dev)
686 struct rte_cryptodev_driver *cryptodrv;
687 struct rte_cryptodev *cryptodev;
689 char cryptodev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
693 cryptodrv = (struct rte_cryptodev_driver *)pci_drv;
694 if (cryptodrv == NULL)
697 rte_pci_device_name(&pci_dev->addr, cryptodev_name,
698 sizeof(cryptodev_name));
700 cryptodev = rte_cryptodev_pmd_allocate(cryptodev_name, rte_socket_id());
701 if (cryptodev == NULL)
704 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
705 cryptodev->data->dev_private =
707 "cryptodev private structure",
708 cryptodrv->dev_private_size,
712 if (cryptodev->data->dev_private == NULL)
713 rte_panic("Cannot allocate memzone for private "
717 cryptodev->device = &pci_dev->device;
718 cryptodev->driver = cryptodrv;
720 /* init user callbacks */
721 TAILQ_INIT(&(cryptodev->link_intr_cbs));
723 /* Invoke PMD device initialization function */
724 retval = (*cryptodrv->cryptodev_init)(cryptodrv, cryptodev);
728 CDEV_LOG_ERR("driver %s: crypto_dev_init(vendor_id=0x%x device_id=0x%x)"
729 " failed", pci_drv->driver.name,
730 (unsigned) pci_dev->id.vendor_id,
731 (unsigned) pci_dev->id.device_id);
733 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
734 rte_free(cryptodev->data->dev_private);
736 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
737 cryptodev_globals.nb_devs--;
743 rte_cryptodev_pci_remove(struct rte_pci_device *pci_dev)
745 const struct rte_cryptodev_driver *cryptodrv;
746 struct rte_cryptodev *cryptodev;
747 char cryptodev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
753 rte_pci_device_name(&pci_dev->addr, cryptodev_name,
754 sizeof(cryptodev_name));
756 cryptodev = rte_cryptodev_pmd_get_named_dev(cryptodev_name);
757 if (cryptodev == NULL)
760 cryptodrv = (const struct rte_cryptodev_driver *)pci_dev->driver;
761 if (cryptodrv == NULL)
764 /* Invoke PMD device uninit function */
765 if (*cryptodrv->cryptodev_uninit) {
766 ret = (*cryptodrv->cryptodev_uninit)(cryptodrv, cryptodev);
771 /* free crypto device */
772 rte_cryptodev_pmd_release_device(cryptodev);
774 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
775 rte_free(cryptodev->data->dev_private);
777 cryptodev->device = NULL;
778 cryptodev->driver = NULL;
779 cryptodev->data = NULL;
785 rte_cryptodev_queue_pair_count(uint8_t dev_id)
787 struct rte_cryptodev *dev;
789 dev = &rte_crypto_devices[dev_id];
790 return dev->data->nb_queue_pairs;
794 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
797 struct rte_cryptodev_info dev_info;
801 if ((dev == NULL) || (nb_qpairs < 1)) {
802 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
807 CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
808 nb_qpairs, dev->data->dev_id);
810 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
812 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
813 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
815 if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
816 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
817 nb_qpairs, dev->data->dev_id);
821 if (dev->data->queue_pairs == NULL) { /* first time configuration */
822 dev->data->queue_pairs = rte_zmalloc_socket(
823 "cryptodev->queue_pairs",
824 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
825 RTE_CACHE_LINE_SIZE, socket_id);
827 if (dev->data->queue_pairs == NULL) {
828 dev->data->nb_queue_pairs = 0;
829 CDEV_LOG_ERR("failed to get memory for qp meta data, "
834 } else { /* re-configure */
836 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
838 qp = dev->data->queue_pairs;
840 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
843 for (i = nb_qpairs; i < old_nb_queues; i++) {
844 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
849 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
850 RTE_CACHE_LINE_SIZE);
852 CDEV_LOG_ERR("failed to realloc qp meta data,"
853 " nb_queues %u", nb_qpairs);
857 if (nb_qpairs > old_nb_queues) {
858 uint16_t new_qs = nb_qpairs - old_nb_queues;
860 memset(qp + old_nb_queues, 0,
861 sizeof(qp[0]) * new_qs);
864 dev->data->queue_pairs = qp;
867 dev->data->nb_queue_pairs = nb_qpairs;
872 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id)
874 struct rte_cryptodev *dev;
876 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
877 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
881 dev = &rte_crypto_devices[dev_id];
882 if (queue_pair_id >= dev->data->nb_queue_pairs) {
883 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
887 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_start, -ENOTSUP);
889 return dev->dev_ops->queue_pair_start(dev, queue_pair_id);
894 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id)
896 struct rte_cryptodev *dev;
898 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
899 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
903 dev = &rte_crypto_devices[dev_id];
904 if (queue_pair_id >= dev->data->nb_queue_pairs) {
905 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
909 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_stop, -ENOTSUP);
911 return dev->dev_ops->queue_pair_stop(dev, queue_pair_id);
916 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
917 unsigned nb_objs, unsigned obj_cache_size, int socket_id);
920 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
922 struct rte_cryptodev *dev;
925 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
926 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
930 dev = &rte_crypto_devices[dev_id];
932 if (dev->data->dev_started) {
934 "device %d must be stopped to allow configuration", dev_id);
938 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
940 /* Setup new number of queue pairs and reconfigure device. */
941 diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
944 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
949 /* Setup Session mempool for device */
950 diag = rte_cryptodev_sym_session_pool_create(dev,
951 config->session_mp.nb_objs,
952 config->session_mp.cache_size,
957 return (*dev->dev_ops->dev_configure)(dev, config);
962 rte_cryptodev_start(uint8_t dev_id)
964 struct rte_cryptodev *dev;
967 CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
969 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
970 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
974 dev = &rte_crypto_devices[dev_id];
976 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
978 if (dev->data->dev_started != 0) {
979 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
984 diag = (*dev->dev_ops->dev_start)(dev);
986 dev->data->dev_started = 1;
994 rte_cryptodev_stop(uint8_t dev_id)
996 struct rte_cryptodev *dev;
998 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
999 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1003 dev = &rte_crypto_devices[dev_id];
1005 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
1007 if (dev->data->dev_started == 0) {
1008 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
1013 dev->data->dev_started = 0;
1014 (*dev->dev_ops->dev_stop)(dev);
1018 rte_cryptodev_close(uint8_t dev_id)
1020 struct rte_cryptodev *dev;
1023 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1024 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1028 dev = &rte_crypto_devices[dev_id];
1030 /* Device must be stopped before it can be closed */
1031 if (dev->data->dev_started == 1) {
1032 CDEV_LOG_ERR("Device %u must be stopped before closing",
1037 /* We can't close the device if there are outstanding sessions in use */
1038 if (dev->data->session_pool != NULL) {
1039 if (!rte_mempool_full(dev->data->session_pool)) {
1040 CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
1041 "has sessions still in use, free "
1042 "all sessions before calling close",
1048 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
1049 retval = (*dev->dev_ops->dev_close)(dev);
1058 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
1059 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id)
1061 struct rte_cryptodev *dev;
1063 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1064 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1068 dev = &rte_crypto_devices[dev_id];
1069 if (queue_pair_id >= dev->data->nb_queue_pairs) {
1070 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
1074 if (dev->data->dev_started) {
1076 "device %d must be stopped to allow configuration", dev_id);
1080 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
1082 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
1088 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
1090 struct rte_cryptodev *dev;
1092 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1093 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1097 if (stats == NULL) {
1098 CDEV_LOG_ERR("Invalid stats ptr");
1102 dev = &rte_crypto_devices[dev_id];
1103 memset(stats, 0, sizeof(*stats));
1105 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
1106 (*dev->dev_ops->stats_get)(dev, stats);
1111 rte_cryptodev_stats_reset(uint8_t dev_id)
1113 struct rte_cryptodev *dev;
1115 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1116 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1120 dev = &rte_crypto_devices[dev_id];
1122 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
1123 (*dev->dev_ops->stats_reset)(dev);
1128 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
1130 struct rte_cryptodev *dev;
1132 if (dev_id >= cryptodev_globals.nb_devs) {
1133 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1137 dev = &rte_crypto_devices[dev_id];
1139 memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
1141 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
1142 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
1144 dev_info->pci_dev = RTE_DEV_TO_PCI(dev->device);
1146 dev_info->driver_name = dev->driver->pci_drv.driver.name;
1151 rte_cryptodev_callback_register(uint8_t dev_id,
1152 enum rte_cryptodev_event_type event,
1153 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1155 struct rte_cryptodev *dev;
1156 struct rte_cryptodev_callback *user_cb;
1161 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1162 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1166 dev = &rte_crypto_devices[dev_id];
1167 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1169 TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
1170 if (user_cb->cb_fn == cb_fn &&
1171 user_cb->cb_arg == cb_arg &&
1172 user_cb->event == event) {
1177 /* create a new callback. */
1178 if (user_cb == NULL) {
1179 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
1180 sizeof(struct rte_cryptodev_callback), 0);
1181 if (user_cb != NULL) {
1182 user_cb->cb_fn = cb_fn;
1183 user_cb->cb_arg = cb_arg;
1184 user_cb->event = event;
1185 TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
1189 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1190 return (user_cb == NULL) ? -ENOMEM : 0;
1194 rte_cryptodev_callback_unregister(uint8_t dev_id,
1195 enum rte_cryptodev_event_type event,
1196 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1199 struct rte_cryptodev *dev;
1200 struct rte_cryptodev_callback *cb, *next;
1205 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1206 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1210 dev = &rte_crypto_devices[dev_id];
1211 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1214 for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
1216 next = TAILQ_NEXT(cb, next);
1218 if (cb->cb_fn != cb_fn || cb->event != event ||
1219 (cb->cb_arg != (void *)-1 &&
1220 cb->cb_arg != cb_arg))
1224 * if this callback is not executing right now,
1227 if (cb->active == 0) {
1228 TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
1235 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1240 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
1241 enum rte_cryptodev_event_type event)
1243 struct rte_cryptodev_callback *cb_lst;
1244 struct rte_cryptodev_callback dev_cb;
1246 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1247 TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
1248 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
1252 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1253 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
1255 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1258 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1263 rte_cryptodev_sym_session_init(struct rte_mempool *mp,
1266 __rte_unused unsigned i)
1268 struct rte_cryptodev_sym_session *sess = _sess;
1269 struct rte_cryptodev *dev = opaque_arg;
1271 memset(sess, 0, mp->elt_size);
1273 sess->dev_id = dev->data->dev_id;
1274 sess->dev_type = dev->dev_type;
1277 if (dev->dev_ops->session_initialize)
1278 (*dev->dev_ops->session_initialize)(mp, sess);
1282 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
1283 unsigned nb_objs, unsigned obj_cache_size, int socket_id)
1285 char mp_name[RTE_CRYPTODEV_NAME_MAX_LEN];
1286 unsigned priv_sess_size;
1288 unsigned n = snprintf(mp_name, sizeof(mp_name), "cdev_%d_sess_mp",
1290 if (n > sizeof(mp_name)) {
1291 CDEV_LOG_ERR("Unable to create unique name for session mempool");
1295 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_get_size, -ENOTSUP);
1296 priv_sess_size = (*dev->dev_ops->session_get_size)(dev);
1297 if (priv_sess_size == 0) {
1298 CDEV_LOG_ERR("%s returned and invalid private session size ",
1303 unsigned elt_size = sizeof(struct rte_cryptodev_sym_session) +
1306 dev->data->session_pool = rte_mempool_lookup(mp_name);
1307 if (dev->data->session_pool != NULL) {
1308 if ((dev->data->session_pool->elt_size != elt_size) ||
1309 (dev->data->session_pool->cache_size <
1311 (dev->data->session_pool->size < nb_objs)) {
1313 CDEV_LOG_ERR("%s mempool already exists with different"
1314 " initialization parameters", mp_name);
1315 dev->data->session_pool = NULL;
1319 dev->data->session_pool = rte_mempool_create(
1320 mp_name, /* mempool name */
1321 nb_objs, /* number of elements*/
1322 elt_size, /* element size*/
1323 obj_cache_size, /* Cache size*/
1324 0, /* private data size */
1325 NULL, /* obj initialization constructor */
1326 NULL, /* obj initialization constructor arg */
1327 rte_cryptodev_sym_session_init,
1328 /**< obj constructor*/
1329 dev, /* obj constructor arg */
1330 socket_id, /* socket id */
1333 if (dev->data->session_pool == NULL) {
1334 CDEV_LOG_ERR("%s mempool allocation failed", mp_name);
1339 CDEV_LOG_DEBUG("%s mempool created!", mp_name);
1343 struct rte_cryptodev_sym_session *
1344 rte_cryptodev_sym_session_create(uint8_t dev_id,
1345 struct rte_crypto_sym_xform *xform)
1347 struct rte_cryptodev *dev;
1348 struct rte_cryptodev_sym_session *sess;
1351 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1352 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1356 dev = &rte_crypto_devices[dev_id];
1358 /* Allocate a session structure from the session pool */
1359 if (rte_mempool_get(dev->data->session_pool, &_sess)) {
1360 CDEV_LOG_ERR("Couldn't get object from session mempool");
1366 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_configure, NULL);
1367 if (dev->dev_ops->session_configure(dev, xform, sess->_private) ==
1369 CDEV_LOG_ERR("dev_id %d failed to configure session details",
1372 /* Return session to mempool */
1373 rte_mempool_put(sess->mp, _sess);
1381 rte_cryptodev_queue_pair_attach_sym_session(uint16_t qp_id,
1382 struct rte_cryptodev_sym_session *sess)
1384 struct rte_cryptodev *dev;
1386 if (!rte_cryptodev_pmd_is_valid_dev(sess->dev_id)) {
1387 CDEV_LOG_ERR("Invalid dev_id=%d", sess->dev_id);
1391 dev = &rte_crypto_devices[sess->dev_id];
1393 /* The API is optional, not returning error if driver do not suuport */
1394 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_attach_session, 0);
1395 if (dev->dev_ops->qp_attach_session(dev, qp_id, sess->_private)) {
1396 CDEV_LOG_ERR("dev_id %d failed to attach qp: %d with session",
1397 sess->dev_id, qp_id);
1405 rte_cryptodev_queue_pair_detach_sym_session(uint16_t qp_id,
1406 struct rte_cryptodev_sym_session *sess)
1408 struct rte_cryptodev *dev;
1410 if (!rte_cryptodev_pmd_is_valid_dev(sess->dev_id)) {
1411 CDEV_LOG_ERR("Invalid dev_id=%d", sess->dev_id);
1415 dev = &rte_crypto_devices[sess->dev_id];
1417 /* The API is optional, not returning error if driver do not suuport */
1418 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_detach_session, 0);
1419 if (dev->dev_ops->qp_detach_session(dev, qp_id, sess->_private)) {
1420 CDEV_LOG_ERR("dev_id %d failed to detach qp: %d from session",
1421 sess->dev_id, qp_id);
1427 struct rte_cryptodev_sym_session *
1428 rte_cryptodev_sym_session_free(uint8_t dev_id,
1429 struct rte_cryptodev_sym_session *sess)
1431 struct rte_cryptodev *dev;
1433 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1434 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1438 dev = &rte_crypto_devices[dev_id];
1440 /* Check the session belongs to this device type */
1441 if (sess->dev_type != dev->dev_type)
1444 /* Let device implementation clear session material */
1445 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_clear, sess);
1446 dev->dev_ops->session_clear(dev, (void *)sess->_private);
1448 /* Return session to mempool */
1449 rte_mempool_put(sess->mp, (void *)sess);
1454 /** Initialise rte_crypto_op mempool element */
1456 rte_crypto_op_init(struct rte_mempool *mempool,
1459 __rte_unused unsigned i)
1461 struct rte_crypto_op *op = _op_data;
1462 enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
1464 memset(_op_data, 0, mempool->elt_size);
1466 __rte_crypto_op_reset(op, type);
1468 op->phys_addr = rte_mem_virt2phy(_op_data);
1469 op->mempool = mempool;
1473 struct rte_mempool *
1474 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
1475 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
1478 struct rte_crypto_op_pool_private *priv;
1480 unsigned elt_size = sizeof(struct rte_crypto_op) +
1481 sizeof(struct rte_crypto_sym_op) +
1484 /* lookup mempool in case already allocated */
1485 struct rte_mempool *mp = rte_mempool_lookup(name);
1488 priv = (struct rte_crypto_op_pool_private *)
1489 rte_mempool_get_priv(mp);
1491 if (mp->elt_size != elt_size ||
1492 mp->cache_size < cache_size ||
1493 mp->size < nb_elts ||
1494 priv->priv_size < priv_size) {
1496 CDEV_LOG_ERR("Mempool %s already exists but with "
1497 "incompatible parameters", name);
1503 mp = rte_mempool_create(
1508 sizeof(struct rte_crypto_op_pool_private),
1517 CDEV_LOG_ERR("Failed to create mempool %s", name);
1521 priv = (struct rte_crypto_op_pool_private *)
1522 rte_mempool_get_priv(mp);
1524 priv->priv_size = priv_size;
1531 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix)
1533 struct rte_cryptodev *dev = NULL;
1539 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
1540 int ret = snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
1541 "%s_%u", dev_name_prefix, i);
1546 dev = rte_cryptodev_pmd_get_named_dev(name);