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>
50 #include <rte_memory.h>
51 #include <rte_memcpy.h>
52 #include <rte_memzone.h>
53 #include <rte_launch.h>
54 #include <rte_tailq.h>
56 #include <rte_per_lcore.h>
57 #include <rte_lcore.h>
58 #include <rte_atomic.h>
59 #include <rte_branch_prediction.h>
60 #include <rte_common.h>
61 #include <rte_mempool.h>
62 #include <rte_malloc.h>
64 #include <rte_errno.h>
65 #include <rte_spinlock.h>
66 #include <rte_string_fns.h>
68 #include "rte_crypto.h"
69 #include "rte_cryptodev.h"
70 #include "rte_cryptodev_pmd.h"
72 static uint8_t nb_drivers;
74 struct rte_cryptodev rte_crypto_devices[RTE_CRYPTO_MAX_DEVS];
76 struct rte_cryptodev *rte_cryptodevs = &rte_crypto_devices[0];
78 static struct rte_cryptodev_global cryptodev_globals = {
79 .devs = &rte_crypto_devices[0],
82 .max_devs = RTE_CRYPTO_MAX_DEVS
85 struct rte_cryptodev_global *rte_cryptodev_globals = &cryptodev_globals;
87 /* spinlock for crypto device callbacks */
88 static rte_spinlock_t rte_cryptodev_cb_lock = RTE_SPINLOCK_INITIALIZER;
92 * The user application callback description.
94 * It contains callback address to be registered by user application,
95 * the pointer to the parameters for callback, and the event type.
97 struct rte_cryptodev_callback {
98 TAILQ_ENTRY(rte_cryptodev_callback) next; /**< Callbacks list */
99 rte_cryptodev_cb_fn cb_fn; /**< Callback address */
100 void *cb_arg; /**< Parameter for callback */
101 enum rte_cryptodev_event_type event; /**< Interrupt event type */
102 uint32_t active; /**< Callback is executing */
106 * The crypto cipher algorithm strings identifiers.
107 * It could be used in application command line.
110 rte_crypto_cipher_algorithm_strings[] = {
111 [RTE_CRYPTO_CIPHER_3DES_CBC] = "3des-cbc",
112 [RTE_CRYPTO_CIPHER_3DES_ECB] = "3des-ecb",
113 [RTE_CRYPTO_CIPHER_3DES_CTR] = "3des-ctr",
115 [RTE_CRYPTO_CIPHER_AES_CBC] = "aes-cbc",
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_F8] = "aes-f8",
120 [RTE_CRYPTO_CIPHER_AES_XTS] = "aes-xts",
122 [RTE_CRYPTO_CIPHER_ARC4] = "arc4",
124 [RTE_CRYPTO_CIPHER_DES_CBC] = "des-cbc",
125 [RTE_CRYPTO_CIPHER_DES_DOCSISBPI] = "des-docsisbpi",
127 [RTE_CRYPTO_CIPHER_NULL] = "null",
129 [RTE_CRYPTO_CIPHER_KASUMI_F8] = "kasumi-f8",
130 [RTE_CRYPTO_CIPHER_SNOW3G_UEA2] = "snow3g-uea2",
131 [RTE_CRYPTO_CIPHER_ZUC_EEA3] = "zuc-eea3"
135 * The crypto cipher operation strings identifiers.
136 * It could be used in application command line.
139 rte_crypto_cipher_operation_strings[] = {
140 [RTE_CRYPTO_CIPHER_OP_ENCRYPT] = "encrypt",
141 [RTE_CRYPTO_CIPHER_OP_DECRYPT] = "decrypt"
145 * The crypto auth algorithm strings identifiers.
146 * It could be used in application command line.
149 rte_crypto_auth_algorithm_strings[] = {
150 [RTE_CRYPTO_AUTH_AES_CBC_MAC] = "aes-cbc-mac",
151 [RTE_CRYPTO_AUTH_AES_CMAC] = "aes-cmac",
152 [RTE_CRYPTO_AUTH_AES_GMAC] = "aes-gmac",
153 [RTE_CRYPTO_AUTH_AES_XCBC_MAC] = "aes-xcbc-mac",
155 [RTE_CRYPTO_AUTH_MD5] = "md5",
156 [RTE_CRYPTO_AUTH_MD5_HMAC] = "md5-hmac",
158 [RTE_CRYPTO_AUTH_NULL] = "null",
160 [RTE_CRYPTO_AUTH_SHA1] = "sha1",
161 [RTE_CRYPTO_AUTH_SHA1_HMAC] = "sha1-hmac",
163 [RTE_CRYPTO_AUTH_SHA224] = "sha2-224",
164 [RTE_CRYPTO_AUTH_SHA224_HMAC] = "sha2-224-hmac",
165 [RTE_CRYPTO_AUTH_SHA256] = "sha2-256",
166 [RTE_CRYPTO_AUTH_SHA256_HMAC] = "sha2-256-hmac",
167 [RTE_CRYPTO_AUTH_SHA384] = "sha2-384",
168 [RTE_CRYPTO_AUTH_SHA384_HMAC] = "sha2-384-hmac",
169 [RTE_CRYPTO_AUTH_SHA512] = "sha2-512",
170 [RTE_CRYPTO_AUTH_SHA512_HMAC] = "sha2-512-hmac",
172 [RTE_CRYPTO_AUTH_KASUMI_F9] = "kasumi-f9",
173 [RTE_CRYPTO_AUTH_SNOW3G_UIA2] = "snow3g-uia2",
174 [RTE_CRYPTO_AUTH_ZUC_EIA3] = "zuc-eia3"
178 * The crypto AEAD algorithm strings identifiers.
179 * It could be used in application command line.
182 rte_crypto_aead_algorithm_strings[] = {
183 [RTE_CRYPTO_AEAD_AES_CCM] = "aes-ccm",
184 [RTE_CRYPTO_AEAD_AES_GCM] = "aes-gcm",
188 * The crypto AEAD operation strings identifiers.
189 * It could be used in application command line.
192 rte_crypto_aead_operation_strings[] = {
193 [RTE_CRYPTO_AEAD_OP_ENCRYPT] = "encrypt",
194 [RTE_CRYPTO_AEAD_OP_DECRYPT] = "decrypt"
198 rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum,
199 const char *algo_string)
203 for (i = 1; i < RTE_DIM(rte_crypto_cipher_algorithm_strings); i++) {
204 if (strcmp(algo_string, rte_crypto_cipher_algorithm_strings[i]) == 0) {
205 *algo_enum = (enum rte_crypto_cipher_algorithm) i;
215 rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum,
216 const char *algo_string)
220 for (i = 1; i < RTE_DIM(rte_crypto_auth_algorithm_strings); i++) {
221 if (strcmp(algo_string, rte_crypto_auth_algorithm_strings[i]) == 0) {
222 *algo_enum = (enum rte_crypto_auth_algorithm) i;
232 rte_cryptodev_get_aead_algo_enum(enum rte_crypto_aead_algorithm *algo_enum,
233 const char *algo_string)
237 for (i = 1; i < RTE_DIM(rte_crypto_aead_algorithm_strings); i++) {
238 if (strcmp(algo_string, rte_crypto_aead_algorithm_strings[i]) == 0) {
239 *algo_enum = (enum rte_crypto_aead_algorithm) i;
249 * The crypto auth operation strings identifiers.
250 * It could be used in application command line.
253 rte_crypto_auth_operation_strings[] = {
254 [RTE_CRYPTO_AUTH_OP_VERIFY] = "verify",
255 [RTE_CRYPTO_AUTH_OP_GENERATE] = "generate"
258 const struct rte_cryptodev_symmetric_capability *
259 rte_cryptodev_sym_capability_get(uint8_t dev_id,
260 const struct rte_cryptodev_sym_capability_idx *idx)
262 const struct rte_cryptodev_capabilities *capability;
263 struct rte_cryptodev_info dev_info;
266 rte_cryptodev_info_get(dev_id, &dev_info);
268 while ((capability = &dev_info.capabilities[i++])->op !=
269 RTE_CRYPTO_OP_TYPE_UNDEFINED) {
270 if (capability->op != RTE_CRYPTO_OP_TYPE_SYMMETRIC)
273 if (capability->sym.xform_type != idx->type)
276 if (idx->type == RTE_CRYPTO_SYM_XFORM_AUTH &&
277 capability->sym.auth.algo == idx->algo.auth)
278 return &capability->sym;
280 if (idx->type == RTE_CRYPTO_SYM_XFORM_CIPHER &&
281 capability->sym.cipher.algo == idx->algo.cipher)
282 return &capability->sym;
284 if (idx->type == RTE_CRYPTO_SYM_XFORM_AEAD &&
285 capability->sym.aead.algo == idx->algo.aead)
286 return &capability->sym;
293 #define param_range_check(x, y) \
294 (((x < y.min) || (x > y.max)) || \
295 (y.increment != 0 && (x % y.increment) != 0))
298 rte_cryptodev_sym_capability_check_cipher(
299 const struct rte_cryptodev_symmetric_capability *capability,
300 uint16_t key_size, uint16_t iv_size)
302 if (param_range_check(key_size, capability->cipher.key_size))
305 if (param_range_check(iv_size, capability->cipher.iv_size))
312 rte_cryptodev_sym_capability_check_auth(
313 const struct rte_cryptodev_symmetric_capability *capability,
314 uint16_t key_size, uint16_t digest_size, uint16_t iv_size)
316 if (param_range_check(key_size, capability->auth.key_size))
319 if (param_range_check(digest_size, capability->auth.digest_size))
322 if (param_range_check(iv_size, capability->auth.iv_size))
329 rte_cryptodev_sym_capability_check_aead(
330 const struct rte_cryptodev_symmetric_capability *capability,
331 uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
334 if (param_range_check(key_size, capability->aead.key_size))
337 if (param_range_check(digest_size, capability->aead.digest_size))
340 if (param_range_check(aad_size, capability->aead.aad_size))
343 if (param_range_check(iv_size, capability->aead.iv_size))
350 rte_cryptodev_get_feature_name(uint64_t flag)
353 case RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO:
354 return "SYMMETRIC_CRYPTO";
355 case RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO:
356 return "ASYMMETRIC_CRYPTO";
357 case RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING:
358 return "SYM_OPERATION_CHAINING";
359 case RTE_CRYPTODEV_FF_CPU_SSE:
361 case RTE_CRYPTODEV_FF_CPU_AVX:
363 case RTE_CRYPTODEV_FF_CPU_AVX2:
365 case RTE_CRYPTODEV_FF_CPU_AESNI:
367 case RTE_CRYPTODEV_FF_HW_ACCELERATED:
368 return "HW_ACCELERATED";
369 case RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER:
370 return "MBUF_SCATTER_GATHER";
371 case RTE_CRYPTODEV_FF_CPU_NEON:
373 case RTE_CRYPTODEV_FF_CPU_ARM_CE:
381 rte_cryptodev_create_vdev(const char *name, const char *args)
383 return rte_vdev_init(name, args);
386 struct rte_cryptodev *
387 rte_cryptodev_pmd_get_dev(uint8_t dev_id)
389 return &rte_cryptodev_globals->devs[dev_id];
392 struct rte_cryptodev *
393 rte_cryptodev_pmd_get_named_dev(const char *name)
395 struct rte_cryptodev *dev;
401 for (i = 0; i < rte_cryptodev_globals->max_devs; i++) {
402 dev = &rte_cryptodev_globals->devs[i];
404 if ((dev->attached == RTE_CRYPTODEV_ATTACHED) &&
405 (strcmp(dev->data->name, name) == 0))
413 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
415 struct rte_cryptodev *dev = NULL;
417 if (dev_id >= rte_cryptodev_globals->nb_devs)
420 dev = rte_cryptodev_pmd_get_dev(dev_id);
421 if (dev->attached != RTE_CRYPTODEV_ATTACHED)
429 rte_cryptodev_get_dev_id(const char *name)
436 for (i = 0; i < rte_cryptodev_globals->nb_devs; i++)
437 if ((strcmp(rte_cryptodev_globals->devs[i].data->name, name)
439 (rte_cryptodev_globals->devs[i].attached ==
440 RTE_CRYPTODEV_ATTACHED))
447 rte_cryptodev_count(void)
449 return rte_cryptodev_globals->nb_devs;
453 rte_cryptodev_device_count_by_driver(uint8_t driver_id)
455 uint8_t i, dev_count = 0;
457 for (i = 0; i < rte_cryptodev_globals->max_devs; i++)
458 if (rte_cryptodev_globals->devs[i].driver_id == driver_id &&
459 rte_cryptodev_globals->devs[i].attached ==
460 RTE_CRYPTODEV_ATTACHED)
467 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
470 uint8_t i, count = 0;
471 struct rte_cryptodev *devs = rte_cryptodev_globals->devs;
472 uint8_t max_devs = rte_cryptodev_globals->max_devs;
474 for (i = 0; i < max_devs && count < nb_devices; i++) {
476 if (devs[i].attached == RTE_CRYPTODEV_ATTACHED) {
479 cmp = strncmp(devs[i].device->driver->name,
481 strlen(driver_name));
484 devices[count++] = devs[i].data->dev_id;
492 rte_cryptodev_socket_id(uint8_t dev_id)
494 struct rte_cryptodev *dev;
496 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
499 dev = rte_cryptodev_pmd_get_dev(dev_id);
501 return dev->data->socket_id;
505 rte_cryptodev_data_alloc(uint8_t dev_id, struct rte_cryptodev_data **data,
508 char mz_name[RTE_CRYPTODEV_NAME_MAX_LEN];
509 const struct rte_memzone *mz;
512 /* generate memzone name */
513 n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
514 if (n >= (int)sizeof(mz_name))
517 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
518 mz = rte_memzone_reserve(mz_name,
519 sizeof(struct rte_cryptodev_data),
522 mz = rte_memzone_lookup(mz_name);
528 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
529 memset(*data, 0, sizeof(struct rte_cryptodev_data));
535 rte_cryptodev_find_free_device_index(void)
539 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) {
540 if (rte_crypto_devices[dev_id].attached ==
541 RTE_CRYPTODEV_DETACHED)
544 return RTE_CRYPTO_MAX_DEVS;
547 struct rte_cryptodev *
548 rte_cryptodev_pmd_allocate(const char *name, int socket_id)
550 struct rte_cryptodev *cryptodev;
553 if (rte_cryptodev_pmd_get_named_dev(name) != NULL) {
554 CDEV_LOG_ERR("Crypto device with name %s already "
559 dev_id = rte_cryptodev_find_free_device_index();
560 if (dev_id == RTE_CRYPTO_MAX_DEVS) {
561 CDEV_LOG_ERR("Reached maximum number of crypto devices");
565 cryptodev = rte_cryptodev_pmd_get_dev(dev_id);
567 if (cryptodev->data == NULL) {
568 struct rte_cryptodev_data *cryptodev_data =
569 cryptodev_globals.data[dev_id];
571 int retval = rte_cryptodev_data_alloc(dev_id, &cryptodev_data,
574 if (retval < 0 || cryptodev_data == NULL)
577 cryptodev->data = cryptodev_data;
579 snprintf(cryptodev->data->name, RTE_CRYPTODEV_NAME_MAX_LEN,
582 cryptodev->data->dev_id = dev_id;
583 cryptodev->data->socket_id = socket_id;
584 cryptodev->data->dev_started = 0;
586 /* init user callbacks */
587 TAILQ_INIT(&(cryptodev->link_intr_cbs));
589 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
591 cryptodev_globals.nb_devs++;
598 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
602 if (cryptodev == NULL)
605 /* Close device only if device operations have been set */
606 if (cryptodev->dev_ops) {
607 ret = rte_cryptodev_close(cryptodev->data->dev_id);
612 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
613 cryptodev_globals.nb_devs--;
618 rte_cryptodev_queue_pair_count(uint8_t dev_id)
620 struct rte_cryptodev *dev;
622 dev = &rte_crypto_devices[dev_id];
623 return dev->data->nb_queue_pairs;
627 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
630 struct rte_cryptodev_info dev_info;
634 if ((dev == NULL) || (nb_qpairs < 1)) {
635 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
640 CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
641 nb_qpairs, dev->data->dev_id);
643 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
645 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
646 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
648 if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
649 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
650 nb_qpairs, dev->data->dev_id);
654 if (dev->data->queue_pairs == NULL) { /* first time configuration */
655 dev->data->queue_pairs = rte_zmalloc_socket(
656 "cryptodev->queue_pairs",
657 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
658 RTE_CACHE_LINE_SIZE, socket_id);
660 if (dev->data->queue_pairs == NULL) {
661 dev->data->nb_queue_pairs = 0;
662 CDEV_LOG_ERR("failed to get memory for qp meta data, "
667 } else { /* re-configure */
669 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
671 qp = dev->data->queue_pairs;
673 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
676 for (i = nb_qpairs; i < old_nb_queues; i++) {
677 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
682 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
683 RTE_CACHE_LINE_SIZE);
685 CDEV_LOG_ERR("failed to realloc qp meta data,"
686 " nb_queues %u", nb_qpairs);
690 if (nb_qpairs > old_nb_queues) {
691 uint16_t new_qs = nb_qpairs - old_nb_queues;
693 memset(qp + old_nb_queues, 0,
694 sizeof(qp[0]) * new_qs);
697 dev->data->queue_pairs = qp;
700 dev->data->nb_queue_pairs = nb_qpairs;
705 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id)
707 struct rte_cryptodev *dev;
709 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
710 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
714 dev = &rte_crypto_devices[dev_id];
715 if (queue_pair_id >= dev->data->nb_queue_pairs) {
716 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
720 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_start, -ENOTSUP);
722 return dev->dev_ops->queue_pair_start(dev, queue_pair_id);
727 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id)
729 struct rte_cryptodev *dev;
731 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
732 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
736 dev = &rte_crypto_devices[dev_id];
737 if (queue_pair_id >= dev->data->nb_queue_pairs) {
738 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
742 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_stop, -ENOTSUP);
744 return dev->dev_ops->queue_pair_stop(dev, queue_pair_id);
749 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
751 struct rte_cryptodev *dev;
754 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
755 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
759 dev = &rte_crypto_devices[dev_id];
761 if (dev->data->dev_started) {
763 "device %d must be stopped to allow configuration", dev_id);
767 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
769 /* Setup new number of queue pairs and reconfigure device. */
770 diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
773 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
778 return (*dev->dev_ops->dev_configure)(dev, config);
783 rte_cryptodev_start(uint8_t dev_id)
785 struct rte_cryptodev *dev;
788 CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
790 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
791 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
795 dev = &rte_crypto_devices[dev_id];
797 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
799 if (dev->data->dev_started != 0) {
800 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
805 diag = (*dev->dev_ops->dev_start)(dev);
807 dev->data->dev_started = 1;
815 rte_cryptodev_stop(uint8_t dev_id)
817 struct rte_cryptodev *dev;
819 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
820 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
824 dev = &rte_crypto_devices[dev_id];
826 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
828 if (dev->data->dev_started == 0) {
829 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
834 (*dev->dev_ops->dev_stop)(dev);
835 dev->data->dev_started = 0;
839 rte_cryptodev_close(uint8_t dev_id)
841 struct rte_cryptodev *dev;
844 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
845 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
849 dev = &rte_crypto_devices[dev_id];
851 /* Device must be stopped before it can be closed */
852 if (dev->data->dev_started == 1) {
853 CDEV_LOG_ERR("Device %u must be stopped before closing",
858 /* We can't close the device if there are outstanding sessions in use */
859 if (dev->data->session_pool != NULL) {
860 if (!rte_mempool_full(dev->data->session_pool)) {
861 CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
862 "has sessions still in use, free "
863 "all sessions before calling close",
869 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
870 retval = (*dev->dev_ops->dev_close)(dev);
879 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
880 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id,
881 struct rte_mempool *session_pool)
884 struct rte_cryptodev *dev;
886 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
887 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
891 dev = &rte_crypto_devices[dev_id];
892 if (queue_pair_id >= dev->data->nb_queue_pairs) {
893 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
897 if (dev->data->dev_started) {
899 "device %d must be stopped to allow configuration", dev_id);
903 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
905 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
906 socket_id, session_pool);
911 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
913 struct rte_cryptodev *dev;
915 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
916 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
921 CDEV_LOG_ERR("Invalid stats ptr");
925 dev = &rte_crypto_devices[dev_id];
926 memset(stats, 0, sizeof(*stats));
928 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
929 (*dev->dev_ops->stats_get)(dev, stats);
934 rte_cryptodev_stats_reset(uint8_t dev_id)
936 struct rte_cryptodev *dev;
938 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
939 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
943 dev = &rte_crypto_devices[dev_id];
945 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
946 (*dev->dev_ops->stats_reset)(dev);
951 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
953 struct rte_cryptodev *dev;
955 if (dev_id >= cryptodev_globals.nb_devs) {
956 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
960 dev = &rte_crypto_devices[dev_id];
962 memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
964 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
965 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
967 dev_info->driver_name = dev->device->driver->name;
972 rte_cryptodev_callback_register(uint8_t dev_id,
973 enum rte_cryptodev_event_type event,
974 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
976 struct rte_cryptodev *dev;
977 struct rte_cryptodev_callback *user_cb;
982 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
983 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
987 dev = &rte_crypto_devices[dev_id];
988 rte_spinlock_lock(&rte_cryptodev_cb_lock);
990 TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
991 if (user_cb->cb_fn == cb_fn &&
992 user_cb->cb_arg == cb_arg &&
993 user_cb->event == event) {
998 /* create a new callback. */
999 if (user_cb == NULL) {
1000 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
1001 sizeof(struct rte_cryptodev_callback), 0);
1002 if (user_cb != NULL) {
1003 user_cb->cb_fn = cb_fn;
1004 user_cb->cb_arg = cb_arg;
1005 user_cb->event = event;
1006 TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
1010 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1011 return (user_cb == NULL) ? -ENOMEM : 0;
1015 rte_cryptodev_callback_unregister(uint8_t dev_id,
1016 enum rte_cryptodev_event_type event,
1017 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1020 struct rte_cryptodev *dev;
1021 struct rte_cryptodev_callback *cb, *next;
1026 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1027 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1031 dev = &rte_crypto_devices[dev_id];
1032 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1035 for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
1037 next = TAILQ_NEXT(cb, next);
1039 if (cb->cb_fn != cb_fn || cb->event != event ||
1040 (cb->cb_arg != (void *)-1 &&
1041 cb->cb_arg != cb_arg))
1045 * if this callback is not executing right now,
1048 if (cb->active == 0) {
1049 TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
1056 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1061 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
1062 enum rte_cryptodev_event_type event)
1064 struct rte_cryptodev_callback *cb_lst;
1065 struct rte_cryptodev_callback dev_cb;
1067 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1068 TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
1069 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
1073 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1074 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
1076 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1079 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1084 rte_cryptodev_sym_session_init(uint8_t dev_id,
1085 struct rte_cryptodev_sym_session *sess,
1086 struct rte_crypto_sym_xform *xforms,
1087 struct rte_mempool *mp)
1089 struct rte_cryptodev *dev;
1093 dev = rte_cryptodev_pmd_get_dev(dev_id);
1095 if (sess == NULL || xforms == NULL || dev == NULL)
1098 index = dev->driver_id;
1100 if (sess->sess_private_data[index] == NULL) {
1101 ret = dev->dev_ops->session_configure(dev, xforms, sess, mp);
1104 "dev_id %d failed to configure session details",
1113 struct rte_cryptodev_sym_session *
1114 rte_cryptodev_sym_session_create(struct rte_mempool *mp)
1116 struct rte_cryptodev_sym_session *sess;
1118 /* Allocate a session structure from the session pool */
1119 if (rte_mempool_get(mp, (void *)&sess)) {
1120 CDEV_LOG_ERR("couldn't get object from session mempool");
1124 /* Clear device session pointer */
1125 memset(sess, 0, (sizeof(void *) * nb_drivers));
1131 rte_cryptodev_queue_pair_attach_sym_session(uint8_t dev_id, uint16_t qp_id,
1132 struct rte_cryptodev_sym_session *sess)
1134 struct rte_cryptodev *dev;
1136 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1137 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1141 dev = &rte_crypto_devices[dev_id];
1143 /* The API is optional, not returning error if driver do not suuport */
1144 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_attach_session, 0);
1146 void *sess_priv = get_session_private_data(sess, dev->driver_id);
1148 if (dev->dev_ops->qp_attach_session(dev, qp_id, sess_priv)) {
1149 CDEV_LOG_ERR("dev_id %d failed to attach qp: %d with session",
1158 rte_cryptodev_queue_pair_detach_sym_session(uint8_t dev_id, uint16_t qp_id,
1159 struct rte_cryptodev_sym_session *sess)
1161 struct rte_cryptodev *dev;
1163 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1164 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1168 dev = &rte_crypto_devices[dev_id];
1170 /* The API is optional, not returning error if driver do not suuport */
1171 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_detach_session, 0);
1173 void *sess_priv = get_session_private_data(sess, dev->driver_id);
1175 if (dev->dev_ops->qp_detach_session(dev, qp_id, sess_priv)) {
1176 CDEV_LOG_ERR("dev_id %d failed to detach qp: %d from session",
1185 rte_cryptodev_sym_session_clear(uint8_t dev_id,
1186 struct rte_cryptodev_sym_session *sess)
1188 struct rte_cryptodev *dev;
1190 dev = rte_cryptodev_pmd_get_dev(dev_id);
1192 if (dev == NULL || sess == NULL)
1195 dev->dev_ops->session_clear(dev, sess);
1201 rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess)
1205 struct rte_mempool *sess_mp;
1210 /* Check that all device private data has been freed */
1211 for (i = 0; i < nb_drivers; i++) {
1212 sess_priv = get_session_private_data(sess, i);
1213 if (sess_priv != NULL)
1217 /* Return session to mempool */
1218 sess_mp = rte_mempool_from_obj(sess);
1219 rte_mempool_put(sess_mp, sess);
1225 rte_cryptodev_get_header_session_size(void)
1228 * Header contains pointers to the private data
1229 * of all registered drivers
1231 return (sizeof(void *) * nb_drivers);
1235 rte_cryptodev_get_private_session_size(uint8_t dev_id)
1237 struct rte_cryptodev *dev;
1238 unsigned int header_size = sizeof(void *) * nb_drivers;
1239 unsigned int priv_sess_size;
1241 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
1244 dev = rte_cryptodev_pmd_get_dev(dev_id);
1246 if (*dev->dev_ops->session_get_size == NULL)
1249 priv_sess_size = (*dev->dev_ops->session_get_size)(dev);
1252 * If size is less than session header size,
1253 * return the latter, as this guarantees that
1254 * sessionless operations will work
1256 if (priv_sess_size < header_size)
1259 return priv_sess_size;
1263 /** Initialise rte_crypto_op mempool element */
1265 rte_crypto_op_init(struct rte_mempool *mempool,
1268 __rte_unused unsigned i)
1270 struct rte_crypto_op *op = _op_data;
1271 enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
1273 memset(_op_data, 0, mempool->elt_size);
1275 __rte_crypto_op_reset(op, type);
1277 op->phys_addr = rte_mem_virt2phy(_op_data);
1278 op->mempool = mempool;
1282 struct rte_mempool *
1283 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
1284 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
1287 struct rte_crypto_op_pool_private *priv;
1289 unsigned elt_size = sizeof(struct rte_crypto_op) +
1290 sizeof(struct rte_crypto_sym_op) +
1293 /* lookup mempool in case already allocated */
1294 struct rte_mempool *mp = rte_mempool_lookup(name);
1297 priv = (struct rte_crypto_op_pool_private *)
1298 rte_mempool_get_priv(mp);
1300 if (mp->elt_size != elt_size ||
1301 mp->cache_size < cache_size ||
1302 mp->size < nb_elts ||
1303 priv->priv_size < priv_size) {
1305 CDEV_LOG_ERR("Mempool %s already exists but with "
1306 "incompatible parameters", name);
1312 mp = rte_mempool_create(
1317 sizeof(struct rte_crypto_op_pool_private),
1326 CDEV_LOG_ERR("Failed to create mempool %s", name);
1330 priv = (struct rte_crypto_op_pool_private *)
1331 rte_mempool_get_priv(mp);
1333 priv->priv_size = priv_size;
1340 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix)
1342 struct rte_cryptodev *dev = NULL;
1348 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
1349 int ret = snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
1350 "%s_%u", dev_name_prefix, i);
1355 dev = rte_cryptodev_pmd_get_named_dev(name);
1363 TAILQ_HEAD(cryptodev_driver_list, cryptodev_driver);
1365 static struct cryptodev_driver_list cryptodev_driver_list =
1366 TAILQ_HEAD_INITIALIZER(cryptodev_driver_list);
1369 rte_cryptodev_driver_id_get(const char *name)
1371 struct cryptodev_driver *driver;
1372 const char *driver_name;
1375 RTE_LOG(DEBUG, CRYPTODEV, "name pointer NULL");
1379 TAILQ_FOREACH(driver, &cryptodev_driver_list, next) {
1380 driver_name = driver->driver->name;
1381 if (strncmp(driver_name, name, strlen(driver_name)) == 0)
1388 rte_cryptodev_name_get(uint8_t dev_id)
1390 struct rte_cryptodev *dev = rte_cryptodev_pmd_get_dev(dev_id);
1395 return dev->data->name;
1399 rte_cryptodev_driver_name_get(uint8_t driver_id)
1401 struct cryptodev_driver *driver;
1403 TAILQ_FOREACH(driver, &cryptodev_driver_list, next)
1404 if (driver->id == driver_id)
1405 return driver->driver->name;
1410 rte_cryptodev_allocate_driver(struct cryptodev_driver *crypto_drv,
1411 const struct rte_driver *drv)
1413 crypto_drv->driver = drv;
1414 crypto_drv->id = nb_drivers;
1416 TAILQ_INSERT_TAIL(&cryptodev_driver_list, crypto_drv, next);
1418 return nb_drivers++;