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"
237 number_of_sockets(void)
241 const struct rte_memseg *ms = rte_eal_get_physmem_layout();
243 for (i = 0; ((i < RTE_MAX_MEMSEG) && (ms[i].addr != NULL)); i++) {
244 if (sockets < ms[i].socket_id)
245 sockets = ms[i].socket_id;
248 /* Number of sockets = maximum socket_id + 1 */
252 /** Parse integer from integer argument */
254 parse_integer_arg(const char *key __rte_unused,
255 const char *value, void *extra_args)
261 CDEV_LOG_ERR("Argument has to be positive.");
270 parse_name_arg(const char *key __rte_unused,
271 const char *value, void *extra_args)
273 struct rte_crypto_vdev_init_params *params = extra_args;
275 if (strlen(value) >= RTE_CRYPTODEV_NAME_MAX_LEN - 1) {
276 CDEV_LOG_ERR("Invalid name %s, should be less than "
278 RTE_CRYPTODEV_NAME_MAX_LEN - 1);
282 strncpy(params->name, value, RTE_CRYPTODEV_NAME_MAX_LEN);
288 rte_cryptodev_parse_vdev_init_params(struct rte_crypto_vdev_init_params *params,
289 const char *input_args)
291 struct rte_kvargs *kvlist = NULL;
298 kvlist = rte_kvargs_parse(input_args,
299 cryptodev_vdev_valid_params);
303 ret = rte_kvargs_process(kvlist,
304 RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
306 ¶ms->max_nb_queue_pairs);
310 ret = rte_kvargs_process(kvlist,
311 RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
313 ¶ms->max_nb_sessions);
317 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SOCKET_ID,
323 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_NAME,
329 if (params->socket_id >= number_of_sockets()) {
330 CDEV_LOG_ERR("Invalid socket id specified to create "
331 "the virtual crypto device on");
337 rte_kvargs_free(kvlist);
341 const struct rte_cryptodev_symmetric_capability *
342 rte_cryptodev_sym_capability_get(uint8_t dev_id,
343 const struct rte_cryptodev_sym_capability_idx *idx)
345 const struct rte_cryptodev_capabilities *capability;
346 struct rte_cryptodev_info dev_info;
349 rte_cryptodev_info_get(dev_id, &dev_info);
351 while ((capability = &dev_info.capabilities[i++])->op !=
352 RTE_CRYPTO_OP_TYPE_UNDEFINED) {
353 if (capability->op != RTE_CRYPTO_OP_TYPE_SYMMETRIC)
356 if (capability->sym.xform_type != idx->type)
359 if (idx->type == RTE_CRYPTO_SYM_XFORM_AUTH &&
360 capability->sym.auth.algo == idx->algo.auth)
361 return &capability->sym;
363 if (idx->type == RTE_CRYPTO_SYM_XFORM_CIPHER &&
364 capability->sym.cipher.algo == idx->algo.cipher)
365 return &capability->sym;
372 #define param_range_check(x, y) \
373 (((x < y.min) || (x > y.max)) || \
374 (y.increment != 0 && (x % y.increment) != 0))
377 rte_cryptodev_sym_capability_check_cipher(
378 const struct rte_cryptodev_symmetric_capability *capability,
379 uint16_t key_size, uint16_t iv_size)
381 if (param_range_check(key_size, capability->cipher.key_size))
384 if (param_range_check(iv_size, capability->cipher.iv_size))
391 rte_cryptodev_sym_capability_check_auth(
392 const struct rte_cryptodev_symmetric_capability *capability,
393 uint16_t key_size, uint16_t digest_size, uint16_t aad_size)
395 if (param_range_check(key_size, capability->auth.key_size))
398 if (param_range_check(digest_size, capability->auth.digest_size))
401 if (param_range_check(aad_size, capability->auth.aad_size))
409 rte_cryptodev_get_feature_name(uint64_t flag)
412 case RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO:
413 return "SYMMETRIC_CRYPTO";
414 case RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO:
415 return "ASYMMETRIC_CRYPTO";
416 case RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING:
417 return "SYM_OPERATION_CHAINING";
418 case RTE_CRYPTODEV_FF_CPU_SSE:
420 case RTE_CRYPTODEV_FF_CPU_AVX:
422 case RTE_CRYPTODEV_FF_CPU_AVX2:
424 case RTE_CRYPTODEV_FF_CPU_AESNI:
426 case RTE_CRYPTODEV_FF_HW_ACCELERATED:
427 return "HW_ACCELERATED";
428 case RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER:
429 return "MBUF_SCATTER_GATHER";
430 case RTE_CRYPTODEV_FF_CPU_NEON:
432 case RTE_CRYPTODEV_FF_CPU_ARM_CE:
440 rte_cryptodev_create_vdev(const char *name, const char *args)
442 return rte_eal_vdev_init(name, args);
445 struct rte_cryptodev *
446 rte_cryptodev_pmd_get_dev(uint8_t dev_id)
448 return &rte_cryptodev_globals->devs[dev_id];
451 struct rte_cryptodev *
452 rte_cryptodev_pmd_get_named_dev(const char *name)
454 struct rte_cryptodev *dev;
460 for (i = 0; i < rte_cryptodev_globals->max_devs; i++) {
461 dev = &rte_cryptodev_globals->devs[i];
463 if ((dev->attached == RTE_CRYPTODEV_ATTACHED) &&
464 (strcmp(dev->data->name, name) == 0))
472 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
474 struct rte_cryptodev *dev = NULL;
476 if (dev_id >= rte_cryptodev_globals->nb_devs)
479 dev = rte_cryptodev_pmd_get_dev(dev_id);
480 if (dev->attached != RTE_CRYPTODEV_ATTACHED)
488 rte_cryptodev_get_dev_id(const char *name)
495 for (i = 0; i < rte_cryptodev_globals->nb_devs; i++)
496 if ((strcmp(rte_cryptodev_globals->devs[i].data->name, name)
498 (rte_cryptodev_globals->devs[i].attached ==
499 RTE_CRYPTODEV_ATTACHED))
506 rte_cryptodev_count(void)
508 return rte_cryptodev_globals->nb_devs;
512 rte_cryptodev_count_devtype(enum rte_cryptodev_type type)
514 uint8_t i, dev_count = 0;
516 for (i = 0; i < rte_cryptodev_globals->max_devs; i++)
517 if (rte_cryptodev_globals->devs[i].dev_type == type &&
518 rte_cryptodev_globals->devs[i].attached ==
519 RTE_CRYPTODEV_ATTACHED)
526 rte_cryptodev_devices_get(const char *dev_name, uint8_t *devices,
529 uint8_t i, count = 0;
530 struct rte_cryptodev *devs = rte_cryptodev_globals->devs;
531 uint8_t max_devs = rte_cryptodev_globals->max_devs;
533 for (i = 0; i < max_devs && count < nb_devices; i++) {
535 if (devs[i].attached == RTE_CRYPTODEV_ATTACHED) {
536 const struct rte_cryptodev_driver *drv = devs[i].driver;
540 cmp = strncmp(drv->pci_drv.driver.name,
541 dev_name, strlen(dev_name));
543 cmp = strncmp(devs[i].data->name,
544 dev_name, strlen(dev_name));
547 devices[count++] = devs[i].data->dev_id;
555 rte_cryptodev_socket_id(uint8_t dev_id)
557 struct rte_cryptodev *dev;
559 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
562 dev = rte_cryptodev_pmd_get_dev(dev_id);
564 return dev->data->socket_id;
568 rte_cryptodev_data_alloc(uint8_t dev_id, struct rte_cryptodev_data **data,
571 char mz_name[RTE_CRYPTODEV_NAME_MAX_LEN];
572 const struct rte_memzone *mz;
575 /* generate memzone name */
576 n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
577 if (n >= (int)sizeof(mz_name))
580 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
581 mz = rte_memzone_reserve(mz_name,
582 sizeof(struct rte_cryptodev_data),
585 mz = rte_memzone_lookup(mz_name);
591 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
592 memset(*data, 0, sizeof(struct rte_cryptodev_data));
598 rte_cryptodev_find_free_device_index(void)
602 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) {
603 if (rte_crypto_devices[dev_id].attached ==
604 RTE_CRYPTODEV_DETACHED)
607 return RTE_CRYPTO_MAX_DEVS;
610 struct rte_cryptodev *
611 rte_cryptodev_pmd_allocate(const char *name, int socket_id)
613 struct rte_cryptodev *cryptodev;
616 if (rte_cryptodev_pmd_get_named_dev(name) != NULL) {
617 CDEV_LOG_ERR("Crypto device with name %s already "
622 dev_id = rte_cryptodev_find_free_device_index();
623 if (dev_id == RTE_CRYPTO_MAX_DEVS) {
624 CDEV_LOG_ERR("Reached maximum number of crypto devices");
628 cryptodev = rte_cryptodev_pmd_get_dev(dev_id);
630 if (cryptodev->data == NULL) {
631 struct rte_cryptodev_data *cryptodev_data =
632 cryptodev_globals.data[dev_id];
634 int retval = rte_cryptodev_data_alloc(dev_id, &cryptodev_data,
637 if (retval < 0 || cryptodev_data == NULL)
640 cryptodev->data = cryptodev_data;
642 snprintf(cryptodev->data->name, RTE_CRYPTODEV_NAME_MAX_LEN,
645 cryptodev->data->dev_id = dev_id;
646 cryptodev->data->socket_id = socket_id;
647 cryptodev->data->dev_started = 0;
649 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
651 cryptodev_globals.nb_devs++;
658 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
662 if (cryptodev == NULL)
665 ret = rte_cryptodev_close(cryptodev->data->dev_id);
669 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
670 cryptodev_globals.nb_devs--;
674 struct rte_cryptodev *
675 rte_cryptodev_pmd_virtual_dev_init(const char *name, size_t dev_private_size,
678 struct rte_cryptodev *cryptodev;
680 /* allocate device structure */
681 cryptodev = rte_cryptodev_pmd_allocate(name, socket_id);
682 if (cryptodev == NULL)
685 /* allocate private device structure */
686 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
687 cryptodev->data->dev_private =
688 rte_zmalloc_socket("cryptodev device private",
693 if (cryptodev->data->dev_private == NULL)
694 rte_panic("Cannot allocate memzone for private device"
698 /* initialise user call-back tail queue */
699 TAILQ_INIT(&(cryptodev->link_intr_cbs));
705 rte_cryptodev_pci_probe(struct rte_pci_driver *pci_drv,
706 struct rte_pci_device *pci_dev)
708 struct rte_cryptodev_driver *cryptodrv;
709 struct rte_cryptodev *cryptodev;
711 char cryptodev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
715 cryptodrv = (struct rte_cryptodev_driver *)pci_drv;
716 if (cryptodrv == NULL)
719 rte_eal_pci_device_name(&pci_dev->addr, cryptodev_name,
720 sizeof(cryptodev_name));
722 cryptodev = rte_cryptodev_pmd_allocate(cryptodev_name, rte_socket_id());
723 if (cryptodev == NULL)
726 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
727 cryptodev->data->dev_private =
729 "cryptodev private structure",
730 cryptodrv->dev_private_size,
734 if (cryptodev->data->dev_private == NULL)
735 rte_panic("Cannot allocate memzone for private "
739 cryptodev->device = &pci_dev->device;
740 cryptodev->driver = cryptodrv;
742 /* init user callbacks */
743 TAILQ_INIT(&(cryptodev->link_intr_cbs));
745 /* Invoke PMD device initialization function */
746 retval = (*cryptodrv->cryptodev_init)(cryptodrv, cryptodev);
750 CDEV_LOG_ERR("driver %s: crypto_dev_init(vendor_id=0x%x device_id=0x%x)"
751 " failed", pci_drv->driver.name,
752 (unsigned) pci_dev->id.vendor_id,
753 (unsigned) pci_dev->id.device_id);
755 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
756 rte_free(cryptodev->data->dev_private);
758 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
759 cryptodev_globals.nb_devs--;
765 rte_cryptodev_pci_remove(struct rte_pci_device *pci_dev)
767 const struct rte_cryptodev_driver *cryptodrv;
768 struct rte_cryptodev *cryptodev;
769 char cryptodev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
775 rte_eal_pci_device_name(&pci_dev->addr, cryptodev_name,
776 sizeof(cryptodev_name));
778 cryptodev = rte_cryptodev_pmd_get_named_dev(cryptodev_name);
779 if (cryptodev == NULL)
782 cryptodrv = (const struct rte_cryptodev_driver *)pci_dev->driver;
783 if (cryptodrv == NULL)
786 /* Invoke PMD device uninit function */
787 if (*cryptodrv->cryptodev_uninit) {
788 ret = (*cryptodrv->cryptodev_uninit)(cryptodrv, cryptodev);
793 /* free crypto device */
794 rte_cryptodev_pmd_release_device(cryptodev);
796 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
797 rte_free(cryptodev->data->dev_private);
799 cryptodev->device = NULL;
800 cryptodev->driver = NULL;
801 cryptodev->data = NULL;
807 rte_cryptodev_queue_pair_count(uint8_t dev_id)
809 struct rte_cryptodev *dev;
811 dev = &rte_crypto_devices[dev_id];
812 return dev->data->nb_queue_pairs;
816 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
819 struct rte_cryptodev_info dev_info;
823 if ((dev == NULL) || (nb_qpairs < 1)) {
824 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
829 CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
830 nb_qpairs, dev->data->dev_id);
832 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
834 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
835 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
837 if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
838 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
839 nb_qpairs, dev->data->dev_id);
843 if (dev->data->queue_pairs == NULL) { /* first time configuration */
844 dev->data->queue_pairs = rte_zmalloc_socket(
845 "cryptodev->queue_pairs",
846 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
847 RTE_CACHE_LINE_SIZE, socket_id);
849 if (dev->data->queue_pairs == NULL) {
850 dev->data->nb_queue_pairs = 0;
851 CDEV_LOG_ERR("failed to get memory for qp meta data, "
856 } else { /* re-configure */
858 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
860 qp = dev->data->queue_pairs;
862 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
865 for (i = nb_qpairs; i < old_nb_queues; i++) {
866 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
871 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
872 RTE_CACHE_LINE_SIZE);
874 CDEV_LOG_ERR("failed to realloc qp meta data,"
875 " nb_queues %u", nb_qpairs);
879 if (nb_qpairs > old_nb_queues) {
880 uint16_t new_qs = nb_qpairs - old_nb_queues;
882 memset(qp + old_nb_queues, 0,
883 sizeof(qp[0]) * new_qs);
886 dev->data->queue_pairs = qp;
889 dev->data->nb_queue_pairs = nb_qpairs;
894 rte_cryptodev_queue_pair_start(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_start, -ENOTSUP);
911 return dev->dev_ops->queue_pair_start(dev, queue_pair_id);
916 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id)
918 struct rte_cryptodev *dev;
920 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
921 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
925 dev = &rte_crypto_devices[dev_id];
926 if (queue_pair_id >= dev->data->nb_queue_pairs) {
927 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
931 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_stop, -ENOTSUP);
933 return dev->dev_ops->queue_pair_stop(dev, queue_pair_id);
938 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
939 unsigned nb_objs, unsigned obj_cache_size, int socket_id);
942 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
944 struct rte_cryptodev *dev;
947 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
948 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
952 dev = &rte_crypto_devices[dev_id];
954 if (dev->data->dev_started) {
956 "device %d must be stopped to allow configuration", dev_id);
960 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
962 /* Setup new number of queue pairs and reconfigure device. */
963 diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
966 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
971 /* Setup Session mempool for device */
972 diag = rte_cryptodev_sym_session_pool_create(dev,
973 config->session_mp.nb_objs,
974 config->session_mp.cache_size,
979 return (*dev->dev_ops->dev_configure)(dev, config);
984 rte_cryptodev_start(uint8_t dev_id)
986 struct rte_cryptodev *dev;
989 CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
991 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
992 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
996 dev = &rte_crypto_devices[dev_id];
998 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
1000 if (dev->data->dev_started != 0) {
1001 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
1006 diag = (*dev->dev_ops->dev_start)(dev);
1008 dev->data->dev_started = 1;
1016 rte_cryptodev_stop(uint8_t dev_id)
1018 struct rte_cryptodev *dev;
1020 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1021 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1025 dev = &rte_crypto_devices[dev_id];
1027 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
1029 if (dev->data->dev_started == 0) {
1030 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
1035 dev->data->dev_started = 0;
1036 (*dev->dev_ops->dev_stop)(dev);
1040 rte_cryptodev_close(uint8_t dev_id)
1042 struct rte_cryptodev *dev;
1045 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1046 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1050 dev = &rte_crypto_devices[dev_id];
1052 /* Device must be stopped before it can be closed */
1053 if (dev->data->dev_started == 1) {
1054 CDEV_LOG_ERR("Device %u must be stopped before closing",
1059 /* We can't close the device if there are outstanding sessions in use */
1060 if (dev->data->session_pool != NULL) {
1061 if (!rte_mempool_full(dev->data->session_pool)) {
1062 CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
1063 "has sessions still in use, free "
1064 "all sessions before calling close",
1070 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
1071 retval = (*dev->dev_ops->dev_close)(dev);
1080 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
1081 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id)
1083 struct rte_cryptodev *dev;
1085 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1086 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1090 dev = &rte_crypto_devices[dev_id];
1091 if (queue_pair_id >= dev->data->nb_queue_pairs) {
1092 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
1096 if (dev->data->dev_started) {
1098 "device %d must be stopped to allow configuration", dev_id);
1102 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
1104 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
1110 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
1112 struct rte_cryptodev *dev;
1114 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1115 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1119 if (stats == NULL) {
1120 CDEV_LOG_ERR("Invalid stats ptr");
1124 dev = &rte_crypto_devices[dev_id];
1125 memset(stats, 0, sizeof(*stats));
1127 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
1128 (*dev->dev_ops->stats_get)(dev, stats);
1133 rte_cryptodev_stats_reset(uint8_t dev_id)
1135 struct rte_cryptodev *dev;
1137 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1138 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1142 dev = &rte_crypto_devices[dev_id];
1144 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
1145 (*dev->dev_ops->stats_reset)(dev);
1150 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
1152 struct rte_cryptodev *dev;
1154 if (dev_id >= cryptodev_globals.nb_devs) {
1155 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1159 dev = &rte_crypto_devices[dev_id];
1161 memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
1163 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
1164 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
1166 dev_info->pci_dev = RTE_DEV_TO_PCI(dev->device);
1168 dev_info->driver_name = dev->driver->pci_drv.driver.name;
1173 rte_cryptodev_callback_register(uint8_t dev_id,
1174 enum rte_cryptodev_event_type event,
1175 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1177 struct rte_cryptodev *dev;
1178 struct rte_cryptodev_callback *user_cb;
1183 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1184 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1188 dev = &rte_crypto_devices[dev_id];
1189 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1191 TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
1192 if (user_cb->cb_fn == cb_fn &&
1193 user_cb->cb_arg == cb_arg &&
1194 user_cb->event == event) {
1199 /* create a new callback. */
1200 if (user_cb == NULL) {
1201 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
1202 sizeof(struct rte_cryptodev_callback), 0);
1203 if (user_cb != NULL) {
1204 user_cb->cb_fn = cb_fn;
1205 user_cb->cb_arg = cb_arg;
1206 user_cb->event = event;
1207 TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
1211 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1212 return (user_cb == NULL) ? -ENOMEM : 0;
1216 rte_cryptodev_callback_unregister(uint8_t dev_id,
1217 enum rte_cryptodev_event_type event,
1218 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1221 struct rte_cryptodev *dev;
1222 struct rte_cryptodev_callback *cb, *next;
1227 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1228 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1232 dev = &rte_crypto_devices[dev_id];
1233 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1236 for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
1238 next = TAILQ_NEXT(cb, next);
1240 if (cb->cb_fn != cb_fn || cb->event != event ||
1241 (cb->cb_arg != (void *)-1 &&
1242 cb->cb_arg != cb_arg))
1246 * if this callback is not executing right now,
1249 if (cb->active == 0) {
1250 TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
1257 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1262 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
1263 enum rte_cryptodev_event_type event)
1265 struct rte_cryptodev_callback *cb_lst;
1266 struct rte_cryptodev_callback dev_cb;
1268 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1269 TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
1270 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
1274 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1275 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
1277 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1280 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1285 rte_cryptodev_sym_session_init(struct rte_mempool *mp,
1288 __rte_unused unsigned i)
1290 struct rte_cryptodev_sym_session *sess = _sess;
1291 struct rte_cryptodev *dev = opaque_arg;
1293 memset(sess, 0, mp->elt_size);
1295 sess->dev_id = dev->data->dev_id;
1296 sess->dev_type = dev->dev_type;
1299 if (dev->dev_ops->session_initialize)
1300 (*dev->dev_ops->session_initialize)(mp, sess);
1304 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
1305 unsigned nb_objs, unsigned obj_cache_size, int socket_id)
1307 char mp_name[RTE_CRYPTODEV_NAME_MAX_LEN];
1308 unsigned priv_sess_size;
1310 unsigned n = snprintf(mp_name, sizeof(mp_name), "cdev_%d_sess_mp",
1312 if (n > sizeof(mp_name)) {
1313 CDEV_LOG_ERR("Unable to create unique name for session mempool");
1317 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_get_size, -ENOTSUP);
1318 priv_sess_size = (*dev->dev_ops->session_get_size)(dev);
1319 if (priv_sess_size == 0) {
1320 CDEV_LOG_ERR("%s returned and invalid private session size ",
1325 unsigned elt_size = sizeof(struct rte_cryptodev_sym_session) +
1328 dev->data->session_pool = rte_mempool_lookup(mp_name);
1329 if (dev->data->session_pool != NULL) {
1330 if ((dev->data->session_pool->elt_size != elt_size) ||
1331 (dev->data->session_pool->cache_size <
1333 (dev->data->session_pool->size < nb_objs)) {
1335 CDEV_LOG_ERR("%s mempool already exists with different"
1336 " initialization parameters", mp_name);
1337 dev->data->session_pool = NULL;
1341 dev->data->session_pool = rte_mempool_create(
1342 mp_name, /* mempool name */
1343 nb_objs, /* number of elements*/
1344 elt_size, /* element size*/
1345 obj_cache_size, /* Cache size*/
1346 0, /* private data size */
1347 NULL, /* obj initialization constructor */
1348 NULL, /* obj initialization constructor arg */
1349 rte_cryptodev_sym_session_init,
1350 /**< obj constructor*/
1351 dev, /* obj constructor arg */
1352 socket_id, /* socket id */
1355 if (dev->data->session_pool == NULL) {
1356 CDEV_LOG_ERR("%s mempool allocation failed", mp_name);
1361 CDEV_LOG_DEBUG("%s mempool created!", mp_name);
1365 struct rte_cryptodev_sym_session *
1366 rte_cryptodev_sym_session_create(uint8_t dev_id,
1367 struct rte_crypto_sym_xform *xform)
1369 struct rte_cryptodev *dev;
1370 struct rte_cryptodev_sym_session *sess;
1373 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1374 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1378 dev = &rte_crypto_devices[dev_id];
1380 /* Allocate a session structure from the session pool */
1381 if (rte_mempool_get(dev->data->session_pool, &_sess)) {
1382 CDEV_LOG_ERR("Couldn't get object from session mempool");
1388 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_configure, NULL);
1389 if (dev->dev_ops->session_configure(dev, xform, sess->_private) ==
1391 CDEV_LOG_ERR("dev_id %d failed to configure session details",
1394 /* Return session to mempool */
1395 rte_mempool_put(sess->mp, _sess);
1403 rte_cryptodev_queue_pair_attach_sym_session(uint16_t qp_id,
1404 struct rte_cryptodev_sym_session *sess)
1406 struct rte_cryptodev *dev;
1408 if (!rte_cryptodev_pmd_is_valid_dev(sess->dev_id)) {
1409 CDEV_LOG_ERR("Invalid dev_id=%d", sess->dev_id);
1413 dev = &rte_crypto_devices[sess->dev_id];
1415 /* The API is optional, not returning error if driver do not suuport */
1416 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_attach_session, 0);
1417 if (dev->dev_ops->qp_attach_session(dev, qp_id, sess->_private)) {
1418 CDEV_LOG_ERR("dev_id %d failed to attach qp: %d with session",
1419 sess->dev_id, qp_id);
1427 rte_cryptodev_queue_pair_detach_sym_session(uint16_t qp_id,
1428 struct rte_cryptodev_sym_session *sess)
1430 struct rte_cryptodev *dev;
1432 if (!rte_cryptodev_pmd_is_valid_dev(sess->dev_id)) {
1433 CDEV_LOG_ERR("Invalid dev_id=%d", sess->dev_id);
1437 dev = &rte_crypto_devices[sess->dev_id];
1439 /* The API is optional, not returning error if driver do not suuport */
1440 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_detach_session, 0);
1441 if (dev->dev_ops->qp_detach_session(dev, qp_id, sess->_private)) {
1442 CDEV_LOG_ERR("dev_id %d failed to detach qp: %d from session",
1443 sess->dev_id, qp_id);
1449 struct rte_cryptodev_sym_session *
1450 rte_cryptodev_sym_session_free(uint8_t dev_id,
1451 struct rte_cryptodev_sym_session *sess)
1453 struct rte_cryptodev *dev;
1455 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1456 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1460 dev = &rte_crypto_devices[dev_id];
1462 /* Check the session belongs to this device type */
1463 if (sess->dev_type != dev->dev_type)
1466 /* Let device implementation clear session material */
1467 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_clear, sess);
1468 dev->dev_ops->session_clear(dev, (void *)sess->_private);
1470 /* Return session to mempool */
1471 rte_mempool_put(sess->mp, (void *)sess);
1476 /** Initialise rte_crypto_op mempool element */
1478 rte_crypto_op_init(struct rte_mempool *mempool,
1481 __rte_unused unsigned i)
1483 struct rte_crypto_op *op = _op_data;
1484 enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
1486 memset(_op_data, 0, mempool->elt_size);
1488 __rte_crypto_op_reset(op, type);
1490 op->phys_addr = rte_mem_virt2phy(_op_data);
1491 op->mempool = mempool;
1495 struct rte_mempool *
1496 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
1497 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
1500 struct rte_crypto_op_pool_private *priv;
1502 unsigned elt_size = sizeof(struct rte_crypto_op) +
1503 sizeof(struct rte_crypto_sym_op) +
1506 /* lookup mempool in case already allocated */
1507 struct rte_mempool *mp = rte_mempool_lookup(name);
1510 priv = (struct rte_crypto_op_pool_private *)
1511 rte_mempool_get_priv(mp);
1513 if (mp->elt_size != elt_size ||
1514 mp->cache_size < cache_size ||
1515 mp->size < nb_elts ||
1516 priv->priv_size < priv_size) {
1518 CDEV_LOG_ERR("Mempool %s already exists but with "
1519 "incompatible parameters", name);
1525 mp = rte_mempool_create(
1530 sizeof(struct rte_crypto_op_pool_private),
1539 CDEV_LOG_ERR("Failed to create mempool %s", name);
1543 priv = (struct rte_crypto_op_pool_private *)
1544 rte_mempool_get_priv(mp);
1546 priv->priv_size = priv_size;
1553 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix)
1555 struct rte_cryptodev *dev = NULL;
1561 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
1562 int ret = snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
1563 "%s_%u", dev_name_prefix, i);
1568 dev = rte_cryptodev_pmd_get_named_dev(name);