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 */
105 * The crypto cipher algorithm strings identifiers.
106 * It could be used in application command line.
109 rte_crypto_cipher_algorithm_strings[] = {
110 [RTE_CRYPTO_CIPHER_3DES_CBC] = "3des-cbc",
111 [RTE_CRYPTO_CIPHER_3DES_ECB] = "3des-ecb",
112 [RTE_CRYPTO_CIPHER_3DES_CTR] = "3des-ctr",
114 [RTE_CRYPTO_CIPHER_AES_CBC] = "aes-cbc",
115 [RTE_CRYPTO_CIPHER_AES_CCM] = "aes-ccm",
116 [RTE_CRYPTO_CIPHER_AES_CTR] = "aes-ctr",
117 [RTE_CRYPTO_CIPHER_AES_DOCSISBPI] = "aes-docsisbpi",
118 [RTE_CRYPTO_CIPHER_AES_ECB] = "aes-ecb",
119 [RTE_CRYPTO_CIPHER_AES_GCM] = "aes-gcm",
120 [RTE_CRYPTO_CIPHER_AES_F8] = "aes-f8",
121 [RTE_CRYPTO_CIPHER_AES_XTS] = "aes-xts",
123 [RTE_CRYPTO_CIPHER_ARC4] = "arc4",
125 [RTE_CRYPTO_CIPHER_DES_CBC] = "des-cbc",
126 [RTE_CRYPTO_CIPHER_DES_DOCSISBPI] = "des-docsisbpi",
128 [RTE_CRYPTO_CIPHER_NULL] = "null",
130 [RTE_CRYPTO_CIPHER_KASUMI_F8] = "kasumi-f8",
131 [RTE_CRYPTO_CIPHER_SNOW3G_UEA2] = "snow3g-uea2",
132 [RTE_CRYPTO_CIPHER_ZUC_EEA3] = "zuc-eea3"
136 * The crypto cipher operation strings identifiers.
137 * It could be used in application command line.
140 rte_crypto_cipher_operation_strings[] = {
141 [RTE_CRYPTO_CIPHER_OP_ENCRYPT] = "encrypt",
142 [RTE_CRYPTO_CIPHER_OP_DECRYPT] = "decrypt"
146 * The crypto auth algorithm strings identifiers.
147 * It could be used in application command line.
150 rte_crypto_auth_algorithm_strings[] = {
151 [RTE_CRYPTO_AUTH_AES_CBC_MAC] = "aes-cbc-mac",
152 [RTE_CRYPTO_AUTH_AES_CCM] = "aes-ccm",
153 [RTE_CRYPTO_AUTH_AES_CMAC] = "aes-cmac",
154 [RTE_CRYPTO_AUTH_AES_GCM] = "aes-gcm",
155 [RTE_CRYPTO_AUTH_AES_GMAC] = "aes-gmac",
156 [RTE_CRYPTO_AUTH_AES_XCBC_MAC] = "aes-xcbc-mac",
158 [RTE_CRYPTO_AUTH_MD5] = "md5",
159 [RTE_CRYPTO_AUTH_MD5_HMAC] = "md5-hmac",
161 [RTE_CRYPTO_AUTH_NULL] = "null",
163 [RTE_CRYPTO_AUTH_SHA1] = "sha1",
164 [RTE_CRYPTO_AUTH_SHA1_HMAC] = "sha1-hmac",
166 [RTE_CRYPTO_AUTH_SHA224] = "sha2-224",
167 [RTE_CRYPTO_AUTH_SHA224_HMAC] = "sha2-224-hmac",
168 [RTE_CRYPTO_AUTH_SHA256] = "sha2-256",
169 [RTE_CRYPTO_AUTH_SHA256_HMAC] = "sha2-256-hmac",
170 [RTE_CRYPTO_AUTH_SHA384] = "sha2-384",
171 [RTE_CRYPTO_AUTH_SHA384_HMAC] = "sha2-384-hmac",
172 [RTE_CRYPTO_AUTH_SHA512] = "sha2-512",
173 [RTE_CRYPTO_AUTH_SHA512_HMAC] = "sha2-512-hmac",
175 [RTE_CRYPTO_AUTH_KASUMI_F9] = "kasumi-f9",
176 [RTE_CRYPTO_AUTH_SNOW3G_UIA2] = "snow3g-uia2",
177 [RTE_CRYPTO_AUTH_ZUC_EIA3] = "zuc-eia3"
181 rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum,
182 const char *algo_string)
186 for (i = 1; i < RTE_DIM(rte_crypto_cipher_algorithm_strings); i++) {
187 if (strcmp(algo_string, rte_crypto_cipher_algorithm_strings[i]) == 0) {
188 *algo_enum = (enum rte_crypto_cipher_algorithm) i;
198 rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum,
199 const char *algo_string)
203 for (i = 1; i < RTE_DIM(rte_crypto_auth_algorithm_strings); i++) {
204 if (strcmp(algo_string, rte_crypto_auth_algorithm_strings[i]) == 0) {
205 *algo_enum = (enum rte_crypto_auth_algorithm) i;
215 * The crypto auth operation strings identifiers.
216 * It could be used in application command line.
219 rte_crypto_auth_operation_strings[] = {
220 [RTE_CRYPTO_AUTH_OP_VERIFY] = "verify",
221 [RTE_CRYPTO_AUTH_OP_GENERATE] = "generate"
224 const struct rte_cryptodev_symmetric_capability *
225 rte_cryptodev_sym_capability_get(uint8_t dev_id,
226 const struct rte_cryptodev_sym_capability_idx *idx)
228 const struct rte_cryptodev_capabilities *capability;
229 struct rte_cryptodev_info dev_info;
232 rte_cryptodev_info_get(dev_id, &dev_info);
234 while ((capability = &dev_info.capabilities[i++])->op !=
235 RTE_CRYPTO_OP_TYPE_UNDEFINED) {
236 if (capability->op != RTE_CRYPTO_OP_TYPE_SYMMETRIC)
239 if (capability->sym.xform_type != idx->type)
242 if (idx->type == RTE_CRYPTO_SYM_XFORM_AUTH &&
243 capability->sym.auth.algo == idx->algo.auth)
244 return &capability->sym;
246 if (idx->type == RTE_CRYPTO_SYM_XFORM_CIPHER &&
247 capability->sym.cipher.algo == idx->algo.cipher)
248 return &capability->sym;
255 #define param_range_check(x, y) \
256 (((x < y.min) || (x > y.max)) || \
257 (y.increment != 0 && (x % y.increment) != 0))
260 rte_cryptodev_sym_capability_check_cipher(
261 const struct rte_cryptodev_symmetric_capability *capability,
262 uint16_t key_size, uint16_t iv_size)
264 if (param_range_check(key_size, capability->cipher.key_size))
267 if (param_range_check(iv_size, capability->cipher.iv_size))
274 rte_cryptodev_sym_capability_check_auth(
275 const struct rte_cryptodev_symmetric_capability *capability,
276 uint16_t key_size, uint16_t digest_size, uint16_t aad_size)
278 if (param_range_check(key_size, capability->auth.key_size))
281 if (param_range_check(digest_size, capability->auth.digest_size))
284 if (param_range_check(aad_size, capability->auth.aad_size))
292 rte_cryptodev_get_feature_name(uint64_t flag)
295 case RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO:
296 return "SYMMETRIC_CRYPTO";
297 case RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO:
298 return "ASYMMETRIC_CRYPTO";
299 case RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING:
300 return "SYM_OPERATION_CHAINING";
301 case RTE_CRYPTODEV_FF_CPU_SSE:
303 case RTE_CRYPTODEV_FF_CPU_AVX:
305 case RTE_CRYPTODEV_FF_CPU_AVX2:
307 case RTE_CRYPTODEV_FF_CPU_AESNI:
309 case RTE_CRYPTODEV_FF_HW_ACCELERATED:
310 return "HW_ACCELERATED";
311 case RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER:
312 return "MBUF_SCATTER_GATHER";
313 case RTE_CRYPTODEV_FF_CPU_NEON:
315 case RTE_CRYPTODEV_FF_CPU_ARM_CE:
323 rte_cryptodev_create_vdev(const char *name, const char *args)
325 return rte_vdev_init(name, args);
328 struct rte_cryptodev *
329 rte_cryptodev_pmd_get_dev(uint8_t dev_id)
331 return &rte_cryptodev_globals->devs[dev_id];
334 struct rte_cryptodev *
335 rte_cryptodev_pmd_get_named_dev(const char *name)
337 struct rte_cryptodev *dev;
343 for (i = 0; i < rte_cryptodev_globals->max_devs; i++) {
344 dev = &rte_cryptodev_globals->devs[i];
346 if ((dev->attached == RTE_CRYPTODEV_ATTACHED) &&
347 (strcmp(dev->data->name, name) == 0))
355 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
357 struct rte_cryptodev *dev = NULL;
359 if (dev_id >= rte_cryptodev_globals->nb_devs)
362 dev = rte_cryptodev_pmd_get_dev(dev_id);
363 if (dev->attached != RTE_CRYPTODEV_ATTACHED)
371 rte_cryptodev_get_dev_id(const char *name)
378 for (i = 0; i < rte_cryptodev_globals->nb_devs; i++)
379 if ((strcmp(rte_cryptodev_globals->devs[i].data->name, name)
381 (rte_cryptodev_globals->devs[i].attached ==
382 RTE_CRYPTODEV_ATTACHED))
389 rte_cryptodev_count(void)
391 return rte_cryptodev_globals->nb_devs;
395 rte_cryptodev_count_devtype(enum rte_cryptodev_type type)
397 uint8_t i, dev_count = 0;
399 for (i = 0; i < rte_cryptodev_globals->max_devs; i++)
400 if (rte_cryptodev_globals->devs[i].dev_type == type &&
401 rte_cryptodev_globals->devs[i].attached ==
402 RTE_CRYPTODEV_ATTACHED)
409 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
412 uint8_t i, count = 0;
413 struct rte_cryptodev *devs = rte_cryptodev_globals->devs;
414 uint8_t max_devs = rte_cryptodev_globals->max_devs;
416 for (i = 0; i < max_devs && count < nb_devices; i++) {
418 if (devs[i].attached == RTE_CRYPTODEV_ATTACHED) {
421 cmp = strncmp(devs[i].device->driver->name,
423 strlen(driver_name));
426 devices[count++] = devs[i].data->dev_id;
434 rte_cryptodev_socket_id(uint8_t dev_id)
436 struct rte_cryptodev *dev;
438 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
441 dev = rte_cryptodev_pmd_get_dev(dev_id);
443 return dev->data->socket_id;
447 rte_cryptodev_data_alloc(uint8_t dev_id, struct rte_cryptodev_data **data,
450 char mz_name[RTE_CRYPTODEV_NAME_MAX_LEN];
451 const struct rte_memzone *mz;
454 /* generate memzone name */
455 n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
456 if (n >= (int)sizeof(mz_name))
459 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
460 mz = rte_memzone_reserve(mz_name,
461 sizeof(struct rte_cryptodev_data),
464 mz = rte_memzone_lookup(mz_name);
470 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
471 memset(*data, 0, sizeof(struct rte_cryptodev_data));
477 rte_cryptodev_find_free_device_index(void)
481 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) {
482 if (rte_crypto_devices[dev_id].attached ==
483 RTE_CRYPTODEV_DETACHED)
486 return RTE_CRYPTO_MAX_DEVS;
489 struct rte_cryptodev *
490 rte_cryptodev_pmd_allocate(const char *name, int socket_id)
492 struct rte_cryptodev *cryptodev;
495 if (rte_cryptodev_pmd_get_named_dev(name) != NULL) {
496 CDEV_LOG_ERR("Crypto device with name %s already "
501 dev_id = rte_cryptodev_find_free_device_index();
502 if (dev_id == RTE_CRYPTO_MAX_DEVS) {
503 CDEV_LOG_ERR("Reached maximum number of crypto devices");
507 cryptodev = rte_cryptodev_pmd_get_dev(dev_id);
509 if (cryptodev->data == NULL) {
510 struct rte_cryptodev_data *cryptodev_data =
511 cryptodev_globals.data[dev_id];
513 int retval = rte_cryptodev_data_alloc(dev_id, &cryptodev_data,
516 if (retval < 0 || cryptodev_data == NULL)
519 cryptodev->data = cryptodev_data;
521 snprintf(cryptodev->data->name, RTE_CRYPTODEV_NAME_MAX_LEN,
524 cryptodev->data->dev_id = dev_id;
525 cryptodev->data->socket_id = socket_id;
526 cryptodev->data->dev_started = 0;
528 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
530 cryptodev_globals.nb_devs++;
537 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
541 if (cryptodev == NULL)
544 ret = rte_cryptodev_close(cryptodev->data->dev_id);
548 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
549 cryptodev_globals.nb_devs--;
554 rte_cryptodev_pci_probe(struct rte_pci_driver *pci_drv,
555 struct rte_pci_device *pci_dev)
557 struct rte_cryptodev_driver *cryptodrv;
558 struct rte_cryptodev *cryptodev;
560 char cryptodev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
564 cryptodrv = (struct rte_cryptodev_driver *)pci_drv;
565 if (cryptodrv == NULL)
568 rte_pci_device_name(&pci_dev->addr, cryptodev_name,
569 sizeof(cryptodev_name));
571 cryptodev = rte_cryptodev_pmd_allocate(cryptodev_name, rte_socket_id());
572 if (cryptodev == NULL)
575 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
576 cryptodev->data->dev_private =
578 "cryptodev private structure",
579 cryptodrv->dev_private_size,
583 if (cryptodev->data->dev_private == NULL)
584 rte_panic("Cannot allocate memzone for private "
588 cryptodev->device = &pci_dev->device;
589 cryptodev->driver = cryptodrv;
591 /* init user callbacks */
592 TAILQ_INIT(&(cryptodev->link_intr_cbs));
594 /* Invoke PMD device initialization function */
595 retval = (*cryptodrv->cryptodev_init)(cryptodrv, cryptodev);
599 CDEV_LOG_ERR("driver %s: crypto_dev_init(vendor_id=0x%x device_id=0x%x)"
600 " failed", pci_drv->driver.name,
601 (unsigned) pci_dev->id.vendor_id,
602 (unsigned) pci_dev->id.device_id);
604 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
605 rte_free(cryptodev->data->dev_private);
607 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
608 cryptodev_globals.nb_devs--;
614 rte_cryptodev_pci_remove(struct rte_pci_device *pci_dev)
616 const struct rte_cryptodev_driver *cryptodrv;
617 struct rte_cryptodev *cryptodev;
618 char cryptodev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
624 rte_pci_device_name(&pci_dev->addr, cryptodev_name,
625 sizeof(cryptodev_name));
627 cryptodev = rte_cryptodev_pmd_get_named_dev(cryptodev_name);
628 if (cryptodev == NULL)
631 cryptodrv = (const struct rte_cryptodev_driver *)pci_dev->driver;
632 if (cryptodrv == NULL)
635 /* Invoke PMD device uninit function */
636 if (*cryptodrv->cryptodev_uninit) {
637 ret = (*cryptodrv->cryptodev_uninit)(cryptodrv, cryptodev);
642 /* free crypto device */
643 rte_cryptodev_pmd_release_device(cryptodev);
645 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
646 rte_free(cryptodev->data->dev_private);
648 cryptodev->device = NULL;
649 cryptodev->driver = NULL;
650 cryptodev->data = NULL;
656 rte_cryptodev_queue_pair_count(uint8_t dev_id)
658 struct rte_cryptodev *dev;
660 dev = &rte_crypto_devices[dev_id];
661 return dev->data->nb_queue_pairs;
665 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
668 struct rte_cryptodev_info dev_info;
672 if ((dev == NULL) || (nb_qpairs < 1)) {
673 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
678 CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
679 nb_qpairs, dev->data->dev_id);
681 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
683 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
684 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
686 if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
687 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
688 nb_qpairs, dev->data->dev_id);
692 if (dev->data->queue_pairs == NULL) { /* first time configuration */
693 dev->data->queue_pairs = rte_zmalloc_socket(
694 "cryptodev->queue_pairs",
695 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
696 RTE_CACHE_LINE_SIZE, socket_id);
698 if (dev->data->queue_pairs == NULL) {
699 dev->data->nb_queue_pairs = 0;
700 CDEV_LOG_ERR("failed to get memory for qp meta data, "
705 } else { /* re-configure */
707 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
709 qp = dev->data->queue_pairs;
711 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
714 for (i = nb_qpairs; i < old_nb_queues; i++) {
715 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
720 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
721 RTE_CACHE_LINE_SIZE);
723 CDEV_LOG_ERR("failed to realloc qp meta data,"
724 " nb_queues %u", nb_qpairs);
728 if (nb_qpairs > old_nb_queues) {
729 uint16_t new_qs = nb_qpairs - old_nb_queues;
731 memset(qp + old_nb_queues, 0,
732 sizeof(qp[0]) * new_qs);
735 dev->data->queue_pairs = qp;
738 dev->data->nb_queue_pairs = nb_qpairs;
743 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id)
745 struct rte_cryptodev *dev;
747 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
748 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
752 dev = &rte_crypto_devices[dev_id];
753 if (queue_pair_id >= dev->data->nb_queue_pairs) {
754 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
758 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_start, -ENOTSUP);
760 return dev->dev_ops->queue_pair_start(dev, queue_pair_id);
765 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id)
767 struct rte_cryptodev *dev;
769 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
770 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
774 dev = &rte_crypto_devices[dev_id];
775 if (queue_pair_id >= dev->data->nb_queue_pairs) {
776 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
780 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_stop, -ENOTSUP);
782 return dev->dev_ops->queue_pair_stop(dev, queue_pair_id);
787 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
788 unsigned nb_objs, unsigned obj_cache_size, int socket_id);
791 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
793 struct rte_cryptodev *dev;
796 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
797 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
801 dev = &rte_crypto_devices[dev_id];
803 if (dev->data->dev_started) {
805 "device %d must be stopped to allow configuration", dev_id);
809 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
811 /* Setup new number of queue pairs and reconfigure device. */
812 diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
815 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
820 /* Setup Session mempool for device */
821 diag = rte_cryptodev_sym_session_pool_create(dev,
822 config->session_mp.nb_objs,
823 config->session_mp.cache_size,
828 return (*dev->dev_ops->dev_configure)(dev, config);
833 rte_cryptodev_start(uint8_t dev_id)
835 struct rte_cryptodev *dev;
838 CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
840 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
841 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
845 dev = &rte_crypto_devices[dev_id];
847 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
849 if (dev->data->dev_started != 0) {
850 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
855 diag = (*dev->dev_ops->dev_start)(dev);
857 dev->data->dev_started = 1;
865 rte_cryptodev_stop(uint8_t dev_id)
867 struct rte_cryptodev *dev;
869 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
870 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
874 dev = &rte_crypto_devices[dev_id];
876 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
878 if (dev->data->dev_started == 0) {
879 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
884 dev->data->dev_started = 0;
885 (*dev->dev_ops->dev_stop)(dev);
889 rte_cryptodev_close(uint8_t dev_id)
891 struct rte_cryptodev *dev;
894 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
895 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
899 dev = &rte_crypto_devices[dev_id];
901 /* Device must be stopped before it can be closed */
902 if (dev->data->dev_started == 1) {
903 CDEV_LOG_ERR("Device %u must be stopped before closing",
908 /* We can't close the device if there are outstanding sessions in use */
909 if (dev->data->session_pool != NULL) {
910 if (!rte_mempool_full(dev->data->session_pool)) {
911 CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
912 "has sessions still in use, free "
913 "all sessions before calling close",
919 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
920 retval = (*dev->dev_ops->dev_close)(dev);
929 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
930 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id)
932 struct rte_cryptodev *dev;
934 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
935 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
939 dev = &rte_crypto_devices[dev_id];
940 if (queue_pair_id >= dev->data->nb_queue_pairs) {
941 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
945 if (dev->data->dev_started) {
947 "device %d must be stopped to allow configuration", dev_id);
951 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
953 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
959 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
961 struct rte_cryptodev *dev;
963 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
964 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
969 CDEV_LOG_ERR("Invalid stats ptr");
973 dev = &rte_crypto_devices[dev_id];
974 memset(stats, 0, sizeof(*stats));
976 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
977 (*dev->dev_ops->stats_get)(dev, stats);
982 rte_cryptodev_stats_reset(uint8_t dev_id)
984 struct rte_cryptodev *dev;
986 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
987 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
991 dev = &rte_crypto_devices[dev_id];
993 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
994 (*dev->dev_ops->stats_reset)(dev);
999 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
1001 struct rte_cryptodev *dev;
1003 if (dev_id >= cryptodev_globals.nb_devs) {
1004 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1008 dev = &rte_crypto_devices[dev_id];
1010 memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
1012 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
1013 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
1015 dev_info->driver_name = dev->device->driver->name;
1020 rte_cryptodev_callback_register(uint8_t dev_id,
1021 enum rte_cryptodev_event_type event,
1022 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1024 struct rte_cryptodev *dev;
1025 struct rte_cryptodev_callback *user_cb;
1030 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1031 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1035 dev = &rte_crypto_devices[dev_id];
1036 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1038 TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
1039 if (user_cb->cb_fn == cb_fn &&
1040 user_cb->cb_arg == cb_arg &&
1041 user_cb->event == event) {
1046 /* create a new callback. */
1047 if (user_cb == NULL) {
1048 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
1049 sizeof(struct rte_cryptodev_callback), 0);
1050 if (user_cb != NULL) {
1051 user_cb->cb_fn = cb_fn;
1052 user_cb->cb_arg = cb_arg;
1053 user_cb->event = event;
1054 TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
1058 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1059 return (user_cb == NULL) ? -ENOMEM : 0;
1063 rte_cryptodev_callback_unregister(uint8_t dev_id,
1064 enum rte_cryptodev_event_type event,
1065 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1068 struct rte_cryptodev *dev;
1069 struct rte_cryptodev_callback *cb, *next;
1074 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1075 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1079 dev = &rte_crypto_devices[dev_id];
1080 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1083 for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
1085 next = TAILQ_NEXT(cb, next);
1087 if (cb->cb_fn != cb_fn || cb->event != event ||
1088 (cb->cb_arg != (void *)-1 &&
1089 cb->cb_arg != cb_arg))
1093 * if this callback is not executing right now,
1096 if (cb->active == 0) {
1097 TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
1104 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1109 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
1110 enum rte_cryptodev_event_type event)
1112 struct rte_cryptodev_callback *cb_lst;
1113 struct rte_cryptodev_callback dev_cb;
1115 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1116 TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
1117 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
1121 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1122 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
1124 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1127 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1132 rte_cryptodev_sym_session_init(struct rte_mempool *mp,
1135 __rte_unused unsigned i)
1137 struct rte_cryptodev_sym_session *sess = _sess;
1138 struct rte_cryptodev *dev = opaque_arg;
1140 memset(sess, 0, mp->elt_size);
1142 sess->dev_id = dev->data->dev_id;
1143 sess->dev_type = dev->dev_type;
1146 if (dev->dev_ops->session_initialize)
1147 (*dev->dev_ops->session_initialize)(mp, sess);
1151 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
1152 unsigned nb_objs, unsigned obj_cache_size, int socket_id)
1154 char mp_name[RTE_CRYPTODEV_NAME_MAX_LEN];
1155 unsigned priv_sess_size;
1157 unsigned n = snprintf(mp_name, sizeof(mp_name), "cdev_%d_sess_mp",
1159 if (n > sizeof(mp_name)) {
1160 CDEV_LOG_ERR("Unable to create unique name for session mempool");
1164 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_get_size, -ENOTSUP);
1165 priv_sess_size = (*dev->dev_ops->session_get_size)(dev);
1166 if (priv_sess_size == 0) {
1167 CDEV_LOG_ERR("%s returned and invalid private session size ",
1172 unsigned elt_size = sizeof(struct rte_cryptodev_sym_session) +
1175 dev->data->session_pool = rte_mempool_lookup(mp_name);
1176 if (dev->data->session_pool != NULL) {
1177 if ((dev->data->session_pool->elt_size != elt_size) ||
1178 (dev->data->session_pool->cache_size <
1180 (dev->data->session_pool->size < nb_objs)) {
1182 CDEV_LOG_ERR("%s mempool already exists with different"
1183 " initialization parameters", mp_name);
1184 dev->data->session_pool = NULL;
1188 dev->data->session_pool = rte_mempool_create(
1189 mp_name, /* mempool name */
1190 nb_objs, /* number of elements*/
1191 elt_size, /* element size*/
1192 obj_cache_size, /* Cache size*/
1193 0, /* private data size */
1194 NULL, /* obj initialization constructor */
1195 NULL, /* obj initialization constructor arg */
1196 rte_cryptodev_sym_session_init,
1197 /**< obj constructor*/
1198 dev, /* obj constructor arg */
1199 socket_id, /* socket id */
1202 if (dev->data->session_pool == NULL) {
1203 CDEV_LOG_ERR("%s mempool allocation failed", mp_name);
1208 CDEV_LOG_DEBUG("%s mempool created!", mp_name);
1212 struct rte_cryptodev_sym_session *
1213 rte_cryptodev_sym_session_create(uint8_t dev_id,
1214 struct rte_crypto_sym_xform *xform)
1216 struct rte_cryptodev *dev;
1217 struct rte_cryptodev_sym_session *sess;
1220 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1221 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1225 dev = &rte_crypto_devices[dev_id];
1227 /* Allocate a session structure from the session pool */
1228 if (rte_mempool_get(dev->data->session_pool, &_sess)) {
1229 CDEV_LOG_ERR("Couldn't get object from session mempool");
1235 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_configure, NULL);
1236 if (dev->dev_ops->session_configure(dev, xform, sess->_private) ==
1238 CDEV_LOG_ERR("dev_id %d failed to configure session details",
1241 /* Return session to mempool */
1242 rte_mempool_put(sess->mp, _sess);
1250 rte_cryptodev_queue_pair_attach_sym_session(uint16_t qp_id,
1251 struct rte_cryptodev_sym_session *sess)
1253 struct rte_cryptodev *dev;
1255 if (!rte_cryptodev_pmd_is_valid_dev(sess->dev_id)) {
1256 CDEV_LOG_ERR("Invalid dev_id=%d", sess->dev_id);
1260 dev = &rte_crypto_devices[sess->dev_id];
1262 /* The API is optional, not returning error if driver do not suuport */
1263 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_attach_session, 0);
1264 if (dev->dev_ops->qp_attach_session(dev, qp_id, sess->_private)) {
1265 CDEV_LOG_ERR("dev_id %d failed to attach qp: %d with session",
1266 sess->dev_id, qp_id);
1274 rte_cryptodev_queue_pair_detach_sym_session(uint16_t qp_id,
1275 struct rte_cryptodev_sym_session *sess)
1277 struct rte_cryptodev *dev;
1279 if (!rte_cryptodev_pmd_is_valid_dev(sess->dev_id)) {
1280 CDEV_LOG_ERR("Invalid dev_id=%d", sess->dev_id);
1284 dev = &rte_crypto_devices[sess->dev_id];
1286 /* The API is optional, not returning error if driver do not suuport */
1287 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_detach_session, 0);
1288 if (dev->dev_ops->qp_detach_session(dev, qp_id, sess->_private)) {
1289 CDEV_LOG_ERR("dev_id %d failed to detach qp: %d from session",
1290 sess->dev_id, qp_id);
1296 struct rte_cryptodev_sym_session *
1297 rte_cryptodev_sym_session_free(uint8_t dev_id,
1298 struct rte_cryptodev_sym_session *sess)
1300 struct rte_cryptodev *dev;
1302 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1303 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1307 dev = &rte_crypto_devices[dev_id];
1309 /* Check the session belongs to this device type */
1310 if (sess->dev_type != dev->dev_type)
1313 /* Let device implementation clear session material */
1314 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_clear, sess);
1315 dev->dev_ops->session_clear(dev, (void *)sess->_private);
1317 /* Return session to mempool */
1318 rte_mempool_put(sess->mp, (void *)sess);
1323 /** Initialise rte_crypto_op mempool element */
1325 rte_crypto_op_init(struct rte_mempool *mempool,
1328 __rte_unused unsigned i)
1330 struct rte_crypto_op *op = _op_data;
1331 enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
1333 memset(_op_data, 0, mempool->elt_size);
1335 __rte_crypto_op_reset(op, type);
1337 op->phys_addr = rte_mem_virt2phy(_op_data);
1338 op->mempool = mempool;
1342 struct rte_mempool *
1343 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
1344 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
1347 struct rte_crypto_op_pool_private *priv;
1349 unsigned elt_size = sizeof(struct rte_crypto_op) +
1350 sizeof(struct rte_crypto_sym_op) +
1353 /* lookup mempool in case already allocated */
1354 struct rte_mempool *mp = rte_mempool_lookup(name);
1357 priv = (struct rte_crypto_op_pool_private *)
1358 rte_mempool_get_priv(mp);
1360 if (mp->elt_size != elt_size ||
1361 mp->cache_size < cache_size ||
1362 mp->size < nb_elts ||
1363 priv->priv_size < priv_size) {
1365 CDEV_LOG_ERR("Mempool %s already exists but with "
1366 "incompatible parameters", name);
1372 mp = rte_mempool_create(
1377 sizeof(struct rte_crypto_op_pool_private),
1386 CDEV_LOG_ERR("Failed to create mempool %s", name);
1390 priv = (struct rte_crypto_op_pool_private *)
1391 rte_mempool_get_priv(mp);
1393 priv->priv_size = priv_size;
1400 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix)
1402 struct rte_cryptodev *dev = NULL;
1408 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
1409 int ret = snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
1410 "%s_%u", dev_name_prefix, i);
1415 dev = rte_cryptodev_pmd_get_named_dev(name);