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 aad_size,
317 if (param_range_check(key_size, capability->auth.key_size))
320 if (param_range_check(digest_size, capability->auth.digest_size))
323 if (param_range_check(aad_size, capability->auth.aad_size))
326 if (param_range_check(iv_size, capability->auth.iv_size))
333 rte_cryptodev_sym_capability_check_aead(
334 const struct rte_cryptodev_symmetric_capability *capability,
335 uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
338 if (param_range_check(key_size, capability->aead.key_size))
341 if (param_range_check(digest_size, capability->aead.digest_size))
344 if (param_range_check(aad_size, capability->aead.aad_size))
347 if (param_range_check(iv_size, capability->aead.iv_size))
354 rte_cryptodev_get_feature_name(uint64_t flag)
357 case RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO:
358 return "SYMMETRIC_CRYPTO";
359 case RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO:
360 return "ASYMMETRIC_CRYPTO";
361 case RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING:
362 return "SYM_OPERATION_CHAINING";
363 case RTE_CRYPTODEV_FF_CPU_SSE:
365 case RTE_CRYPTODEV_FF_CPU_AVX:
367 case RTE_CRYPTODEV_FF_CPU_AVX2:
369 case RTE_CRYPTODEV_FF_CPU_AESNI:
371 case RTE_CRYPTODEV_FF_HW_ACCELERATED:
372 return "HW_ACCELERATED";
373 case RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER:
374 return "MBUF_SCATTER_GATHER";
375 case RTE_CRYPTODEV_FF_CPU_NEON:
377 case RTE_CRYPTODEV_FF_CPU_ARM_CE:
385 rte_cryptodev_create_vdev(const char *name, const char *args)
387 return rte_vdev_init(name, args);
390 struct rte_cryptodev *
391 rte_cryptodev_pmd_get_dev(uint8_t dev_id)
393 return &rte_cryptodev_globals->devs[dev_id];
396 struct rte_cryptodev *
397 rte_cryptodev_pmd_get_named_dev(const char *name)
399 struct rte_cryptodev *dev;
405 for (i = 0; i < rte_cryptodev_globals->max_devs; i++) {
406 dev = &rte_cryptodev_globals->devs[i];
408 if ((dev->attached == RTE_CRYPTODEV_ATTACHED) &&
409 (strcmp(dev->data->name, name) == 0))
417 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
419 struct rte_cryptodev *dev = NULL;
421 if (dev_id >= rte_cryptodev_globals->nb_devs)
424 dev = rte_cryptodev_pmd_get_dev(dev_id);
425 if (dev->attached != RTE_CRYPTODEV_ATTACHED)
433 rte_cryptodev_get_dev_id(const char *name)
440 for (i = 0; i < rte_cryptodev_globals->nb_devs; i++)
441 if ((strcmp(rte_cryptodev_globals->devs[i].data->name, name)
443 (rte_cryptodev_globals->devs[i].attached ==
444 RTE_CRYPTODEV_ATTACHED))
451 rte_cryptodev_count(void)
453 return rte_cryptodev_globals->nb_devs;
457 rte_cryptodev_device_count_by_driver(uint8_t driver_id)
459 uint8_t i, dev_count = 0;
461 for (i = 0; i < rte_cryptodev_globals->max_devs; i++)
462 if (rte_cryptodev_globals->devs[i].driver_id == driver_id &&
463 rte_cryptodev_globals->devs[i].attached ==
464 RTE_CRYPTODEV_ATTACHED)
471 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
474 uint8_t i, count = 0;
475 struct rte_cryptodev *devs = rte_cryptodev_globals->devs;
476 uint8_t max_devs = rte_cryptodev_globals->max_devs;
478 for (i = 0; i < max_devs && count < nb_devices; i++) {
480 if (devs[i].attached == RTE_CRYPTODEV_ATTACHED) {
483 cmp = strncmp(devs[i].device->driver->name,
485 strlen(driver_name));
488 devices[count++] = devs[i].data->dev_id;
496 rte_cryptodev_socket_id(uint8_t dev_id)
498 struct rte_cryptodev *dev;
500 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
503 dev = rte_cryptodev_pmd_get_dev(dev_id);
505 return dev->data->socket_id;
509 rte_cryptodev_data_alloc(uint8_t dev_id, struct rte_cryptodev_data **data,
512 char mz_name[RTE_CRYPTODEV_NAME_MAX_LEN];
513 const struct rte_memzone *mz;
516 /* generate memzone name */
517 n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
518 if (n >= (int)sizeof(mz_name))
521 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
522 mz = rte_memzone_reserve(mz_name,
523 sizeof(struct rte_cryptodev_data),
526 mz = rte_memzone_lookup(mz_name);
532 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
533 memset(*data, 0, sizeof(struct rte_cryptodev_data));
539 rte_cryptodev_find_free_device_index(void)
543 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) {
544 if (rte_crypto_devices[dev_id].attached ==
545 RTE_CRYPTODEV_DETACHED)
548 return RTE_CRYPTO_MAX_DEVS;
551 struct rte_cryptodev *
552 rte_cryptodev_pmd_allocate(const char *name, int socket_id)
554 struct rte_cryptodev *cryptodev;
557 if (rte_cryptodev_pmd_get_named_dev(name) != NULL) {
558 CDEV_LOG_ERR("Crypto device with name %s already "
563 dev_id = rte_cryptodev_find_free_device_index();
564 if (dev_id == RTE_CRYPTO_MAX_DEVS) {
565 CDEV_LOG_ERR("Reached maximum number of crypto devices");
569 cryptodev = rte_cryptodev_pmd_get_dev(dev_id);
571 if (cryptodev->data == NULL) {
572 struct rte_cryptodev_data *cryptodev_data =
573 cryptodev_globals.data[dev_id];
575 int retval = rte_cryptodev_data_alloc(dev_id, &cryptodev_data,
578 if (retval < 0 || cryptodev_data == NULL)
581 cryptodev->data = cryptodev_data;
583 snprintf(cryptodev->data->name, RTE_CRYPTODEV_NAME_MAX_LEN,
586 cryptodev->data->dev_id = dev_id;
587 cryptodev->data->socket_id = socket_id;
588 cryptodev->data->dev_started = 0;
590 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
592 cryptodev_globals.nb_devs++;
599 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
603 if (cryptodev == NULL)
606 /* Close device only if device operations have been set */
607 if (cryptodev->dev_ops) {
608 ret = rte_cryptodev_close(cryptodev->data->dev_id);
613 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
614 cryptodev_globals.nb_devs--;
619 rte_cryptodev_queue_pair_count(uint8_t dev_id)
621 struct rte_cryptodev *dev;
623 dev = &rte_crypto_devices[dev_id];
624 return dev->data->nb_queue_pairs;
628 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
631 struct rte_cryptodev_info dev_info;
635 if ((dev == NULL) || (nb_qpairs < 1)) {
636 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
641 CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
642 nb_qpairs, dev->data->dev_id);
644 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
646 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
647 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
649 if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
650 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
651 nb_qpairs, dev->data->dev_id);
655 if (dev->data->queue_pairs == NULL) { /* first time configuration */
656 dev->data->queue_pairs = rte_zmalloc_socket(
657 "cryptodev->queue_pairs",
658 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
659 RTE_CACHE_LINE_SIZE, socket_id);
661 if (dev->data->queue_pairs == NULL) {
662 dev->data->nb_queue_pairs = 0;
663 CDEV_LOG_ERR("failed to get memory for qp meta data, "
668 } else { /* re-configure */
670 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
672 qp = dev->data->queue_pairs;
674 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
677 for (i = nb_qpairs; i < old_nb_queues; i++) {
678 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
683 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
684 RTE_CACHE_LINE_SIZE);
686 CDEV_LOG_ERR("failed to realloc qp meta data,"
687 " nb_queues %u", nb_qpairs);
691 if (nb_qpairs > old_nb_queues) {
692 uint16_t new_qs = nb_qpairs - old_nb_queues;
694 memset(qp + old_nb_queues, 0,
695 sizeof(qp[0]) * new_qs);
698 dev->data->queue_pairs = qp;
701 dev->data->nb_queue_pairs = nb_qpairs;
706 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id)
708 struct rte_cryptodev *dev;
710 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
711 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
715 dev = &rte_crypto_devices[dev_id];
716 if (queue_pair_id >= dev->data->nb_queue_pairs) {
717 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
721 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_start, -ENOTSUP);
723 return dev->dev_ops->queue_pair_start(dev, queue_pair_id);
728 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id)
730 struct rte_cryptodev *dev;
732 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
733 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
737 dev = &rte_crypto_devices[dev_id];
738 if (queue_pair_id >= dev->data->nb_queue_pairs) {
739 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
743 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_stop, -ENOTSUP);
745 return dev->dev_ops->queue_pair_stop(dev, queue_pair_id);
750 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
752 struct rte_cryptodev *dev;
755 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
756 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
760 dev = &rte_crypto_devices[dev_id];
762 if (dev->data->dev_started) {
764 "device %d must be stopped to allow configuration", dev_id);
768 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
770 /* Setup new number of queue pairs and reconfigure device. */
771 diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
774 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
779 return (*dev->dev_ops->dev_configure)(dev, config);
784 rte_cryptodev_start(uint8_t dev_id)
786 struct rte_cryptodev *dev;
789 CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
791 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
792 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
796 dev = &rte_crypto_devices[dev_id];
798 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
800 if (dev->data->dev_started != 0) {
801 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
806 diag = (*dev->dev_ops->dev_start)(dev);
808 dev->data->dev_started = 1;
816 rte_cryptodev_stop(uint8_t dev_id)
818 struct rte_cryptodev *dev;
820 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
821 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
825 dev = &rte_crypto_devices[dev_id];
827 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
829 if (dev->data->dev_started == 0) {
830 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
835 (*dev->dev_ops->dev_stop)(dev);
836 dev->data->dev_started = 0;
840 rte_cryptodev_close(uint8_t dev_id)
842 struct rte_cryptodev *dev;
845 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
846 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
850 dev = &rte_crypto_devices[dev_id];
852 /* Device must be stopped before it can be closed */
853 if (dev->data->dev_started == 1) {
854 CDEV_LOG_ERR("Device %u must be stopped before closing",
859 /* We can't close the device if there are outstanding sessions in use */
860 if (dev->data->session_pool != NULL) {
861 if (!rte_mempool_full(dev->data->session_pool)) {
862 CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
863 "has sessions still in use, free "
864 "all sessions before calling close",
870 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
871 retval = (*dev->dev_ops->dev_close)(dev);
880 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
881 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id,
882 struct rte_mempool *session_pool)
885 struct rte_cryptodev *dev;
887 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
888 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
892 dev = &rte_crypto_devices[dev_id];
893 if (queue_pair_id >= dev->data->nb_queue_pairs) {
894 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
898 if (dev->data->dev_started) {
900 "device %d must be stopped to allow configuration", dev_id);
904 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
906 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
907 socket_id, session_pool);
912 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
914 struct rte_cryptodev *dev;
916 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
917 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
922 CDEV_LOG_ERR("Invalid stats ptr");
926 dev = &rte_crypto_devices[dev_id];
927 memset(stats, 0, sizeof(*stats));
929 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
930 (*dev->dev_ops->stats_get)(dev, stats);
935 rte_cryptodev_stats_reset(uint8_t dev_id)
937 struct rte_cryptodev *dev;
939 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
940 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
944 dev = &rte_crypto_devices[dev_id];
946 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
947 (*dev->dev_ops->stats_reset)(dev);
952 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
954 struct rte_cryptodev *dev;
956 if (dev_id >= cryptodev_globals.nb_devs) {
957 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
961 dev = &rte_crypto_devices[dev_id];
963 memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
965 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
966 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
968 dev_info->driver_name = dev->device->driver->name;
973 rte_cryptodev_callback_register(uint8_t dev_id,
974 enum rte_cryptodev_event_type event,
975 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
977 struct rte_cryptodev *dev;
978 struct rte_cryptodev_callback *user_cb;
983 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
984 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
988 dev = &rte_crypto_devices[dev_id];
989 rte_spinlock_lock(&rte_cryptodev_cb_lock);
991 TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
992 if (user_cb->cb_fn == cb_fn &&
993 user_cb->cb_arg == cb_arg &&
994 user_cb->event == event) {
999 /* create a new callback. */
1000 if (user_cb == NULL) {
1001 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
1002 sizeof(struct rte_cryptodev_callback), 0);
1003 if (user_cb != NULL) {
1004 user_cb->cb_fn = cb_fn;
1005 user_cb->cb_arg = cb_arg;
1006 user_cb->event = event;
1007 TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
1011 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1012 return (user_cb == NULL) ? -ENOMEM : 0;
1016 rte_cryptodev_callback_unregister(uint8_t dev_id,
1017 enum rte_cryptodev_event_type event,
1018 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1021 struct rte_cryptodev *dev;
1022 struct rte_cryptodev_callback *cb, *next;
1027 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1028 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1032 dev = &rte_crypto_devices[dev_id];
1033 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1036 for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
1038 next = TAILQ_NEXT(cb, next);
1040 if (cb->cb_fn != cb_fn || cb->event != event ||
1041 (cb->cb_arg != (void *)-1 &&
1042 cb->cb_arg != cb_arg))
1046 * if this callback is not executing right now,
1049 if (cb->active == 0) {
1050 TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
1057 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1062 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
1063 enum rte_cryptodev_event_type event)
1065 struct rte_cryptodev_callback *cb_lst;
1066 struct rte_cryptodev_callback dev_cb;
1068 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1069 TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
1070 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
1074 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1075 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
1077 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1080 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1085 rte_cryptodev_sym_session_init(uint8_t dev_id,
1086 struct rte_cryptodev_sym_session *sess,
1087 struct rte_crypto_sym_xform *xforms,
1088 struct rte_mempool *mp)
1090 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 if (dev->dev_ops->session_configure(dev, xforms, sess, mp) < 0) {
1103 "dev_id %d failed to configure session details",
1112 struct rte_cryptodev_sym_session *
1113 rte_cryptodev_sym_session_create(struct rte_mempool *mp)
1115 struct rte_cryptodev_sym_session *sess;
1117 /* Allocate a session structure from the session pool */
1118 if (rte_mempool_get(mp, (void *)&sess)) {
1119 CDEV_LOG_ERR("couldn't get object from session mempool");
1123 /* Clear device session pointer */
1124 memset(sess, 0, (sizeof(void *) * nb_drivers));
1130 rte_cryptodev_queue_pair_attach_sym_session(uint8_t dev_id, uint16_t qp_id,
1131 struct rte_cryptodev_sym_session *sess)
1133 struct rte_cryptodev *dev;
1135 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1136 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1140 dev = &rte_crypto_devices[dev_id];
1142 /* The API is optional, not returning error if driver do not suuport */
1143 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_attach_session, 0);
1145 void *sess_priv = get_session_private_data(sess, dev->driver_id);
1147 if (dev->dev_ops->qp_attach_session(dev, qp_id, sess_priv)) {
1148 CDEV_LOG_ERR("dev_id %d failed to attach qp: %d with session",
1157 rte_cryptodev_queue_pair_detach_sym_session(uint8_t dev_id, uint16_t qp_id,
1158 struct rte_cryptodev_sym_session *sess)
1160 struct rte_cryptodev *dev;
1162 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1163 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1167 dev = &rte_crypto_devices[dev_id];
1169 /* The API is optional, not returning error if driver do not suuport */
1170 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_detach_session, 0);
1172 void *sess_priv = get_session_private_data(sess, dev->driver_id);
1174 if (dev->dev_ops->qp_detach_session(dev, qp_id, sess_priv)) {
1175 CDEV_LOG_ERR("dev_id %d failed to detach qp: %d from session",
1184 rte_cryptodev_sym_session_clear(uint8_t dev_id,
1185 struct rte_cryptodev_sym_session *sess)
1187 struct rte_cryptodev *dev;
1189 dev = rte_cryptodev_pmd_get_dev(dev_id);
1191 if (dev == NULL || sess == NULL)
1194 dev->dev_ops->session_clear(dev, sess);
1200 rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess)
1204 struct rte_mempool *sess_mp;
1209 /* Check that all device private data has been freed */
1210 for (i = 0; i < nb_drivers; i++) {
1211 sess_priv = get_session_private_data(sess, i);
1212 if (sess_priv != NULL)
1216 /* Return session to mempool */
1217 sess_mp = rte_mempool_from_obj(sess);
1218 rte_mempool_put(sess_mp, sess);
1224 rte_cryptodev_get_header_session_size(void)
1227 * Header contains pointers to the private data
1228 * of all registered drivers
1230 return (sizeof(void *) * nb_drivers);
1234 rte_cryptodev_get_private_session_size(uint8_t dev_id)
1236 struct rte_cryptodev *dev;
1237 unsigned int header_size = sizeof(void *) * nb_drivers;
1238 unsigned int priv_sess_size;
1240 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
1243 dev = rte_cryptodev_pmd_get_dev(dev_id);
1245 if (*dev->dev_ops->session_get_size == NULL)
1248 priv_sess_size = (*dev->dev_ops->session_get_size)(dev);
1251 * If size is less than session header size,
1252 * return the latter, as this guarantees that
1253 * sessionless operations will work
1255 if (priv_sess_size < header_size)
1258 return priv_sess_size;
1262 /** Initialise rte_crypto_op mempool element */
1264 rte_crypto_op_init(struct rte_mempool *mempool,
1267 __rte_unused unsigned i)
1269 struct rte_crypto_op *op = _op_data;
1270 enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
1272 memset(_op_data, 0, mempool->elt_size);
1274 __rte_crypto_op_reset(op, type);
1276 op->phys_addr = rte_mem_virt2phy(_op_data);
1277 op->mempool = mempool;
1281 struct rte_mempool *
1282 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
1283 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
1286 struct rte_crypto_op_pool_private *priv;
1288 unsigned elt_size = sizeof(struct rte_crypto_op) +
1289 sizeof(struct rte_crypto_sym_op) +
1292 /* lookup mempool in case already allocated */
1293 struct rte_mempool *mp = rte_mempool_lookup(name);
1296 priv = (struct rte_crypto_op_pool_private *)
1297 rte_mempool_get_priv(mp);
1299 if (mp->elt_size != elt_size ||
1300 mp->cache_size < cache_size ||
1301 mp->size < nb_elts ||
1302 priv->priv_size < priv_size) {
1304 CDEV_LOG_ERR("Mempool %s already exists but with "
1305 "incompatible parameters", name);
1311 mp = rte_mempool_create(
1316 sizeof(struct rte_crypto_op_pool_private),
1325 CDEV_LOG_ERR("Failed to create mempool %s", name);
1329 priv = (struct rte_crypto_op_pool_private *)
1330 rte_mempool_get_priv(mp);
1332 priv->priv_size = priv_size;
1339 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix)
1341 struct rte_cryptodev *dev = NULL;
1347 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
1348 int ret = snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
1349 "%s_%u", dev_name_prefix, i);
1354 dev = rte_cryptodev_pmd_get_named_dev(name);
1362 TAILQ_HEAD(cryptodev_driver_list, cryptodev_driver);
1364 static struct cryptodev_driver_list cryptodev_driver_list =
1365 TAILQ_HEAD_INITIALIZER(cryptodev_driver_list);
1367 struct cryptodev_driver {
1368 TAILQ_ENTRY(cryptodev_driver) next; /**< Next in list. */
1369 const struct rte_driver *driver;
1374 rte_cryptodev_driver_id_get(const char *name)
1376 struct cryptodev_driver *driver;
1377 const char *driver_name;
1380 RTE_LOG(DEBUG, CRYPTODEV, "name pointer NULL");
1384 TAILQ_FOREACH(driver, &cryptodev_driver_list, next) {
1385 driver_name = driver->driver->name;
1386 if (strncmp(driver_name, name, strlen(driver_name)) == 0)
1393 rte_cryptodev_driver_name_get(uint8_t driver_id)
1395 struct cryptodev_driver *driver;
1397 TAILQ_FOREACH(driver, &cryptodev_driver_list, next)
1398 if (driver->id == driver_id)
1399 return driver->driver->name;
1404 rte_cryptodev_allocate_driver(const struct rte_driver *drv)
1406 struct cryptodev_driver *driver;
1408 driver = malloc(sizeof(*driver));
1409 driver->driver = drv;
1410 driver->id = nb_drivers;
1412 TAILQ_INSERT_TAIL(&cryptodev_driver_list, driver, next);
1414 return nb_drivers++;