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 struct rte_cryptodev rte_crypto_devices[RTE_CRYPTO_MAX_DEVS];
74 struct rte_cryptodev *rte_cryptodevs = &rte_crypto_devices[0];
76 static struct rte_cryptodev_global cryptodev_globals = {
77 .devs = &rte_crypto_devices[0],
80 .max_devs = RTE_CRYPTO_MAX_DEVS
83 struct rte_cryptodev_global *rte_cryptodev_globals = &cryptodev_globals;
85 /* spinlock for crypto device callbacks */
86 static rte_spinlock_t rte_cryptodev_cb_lock = RTE_SPINLOCK_INITIALIZER;
90 * The user application callback description.
92 * It contains callback address to be registered by user application,
93 * the pointer to the parameters for callback, and the event type.
95 struct rte_cryptodev_callback {
96 TAILQ_ENTRY(rte_cryptodev_callback) next; /**< Callbacks list */
97 rte_cryptodev_cb_fn cb_fn; /**< Callback address */
98 void *cb_arg; /**< Parameter for callback */
99 enum rte_cryptodev_event_type event; /**< Interrupt event type */
100 uint32_t active; /**< Callback is executing */
104 * The crypto cipher algorithm strings identifiers.
105 * It could be used in application command line.
108 rte_crypto_cipher_algorithm_strings[] = {
109 [RTE_CRYPTO_CIPHER_3DES_CBC] = "3des-cbc",
110 [RTE_CRYPTO_CIPHER_3DES_ECB] = "3des-ecb",
111 [RTE_CRYPTO_CIPHER_3DES_CTR] = "3des-ctr",
113 [RTE_CRYPTO_CIPHER_AES_CBC] = "aes-cbc",
114 [RTE_CRYPTO_CIPHER_AES_CCM] = "aes-ccm",
115 [RTE_CRYPTO_CIPHER_AES_CTR] = "aes-ctr",
116 [RTE_CRYPTO_CIPHER_AES_DOCSISBPI] = "aes-docsisbpi",
117 [RTE_CRYPTO_CIPHER_AES_ECB] = "aes-ecb",
118 [RTE_CRYPTO_CIPHER_AES_GCM] = "aes-gcm",
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_CCM] = "aes-ccm",
152 [RTE_CRYPTO_AUTH_AES_CMAC] = "aes-cmac",
153 [RTE_CRYPTO_AUTH_AES_GCM] = "aes-gcm",
154 [RTE_CRYPTO_AUTH_AES_GMAC] = "aes-gmac",
155 [RTE_CRYPTO_AUTH_AES_XCBC_MAC] = "aes-xcbc-mac",
157 [RTE_CRYPTO_AUTH_MD5] = "md5",
158 [RTE_CRYPTO_AUTH_MD5_HMAC] = "md5-hmac",
160 [RTE_CRYPTO_AUTH_NULL] = "null",
162 [RTE_CRYPTO_AUTH_SHA1] = "sha1",
163 [RTE_CRYPTO_AUTH_SHA1_HMAC] = "sha1-hmac",
165 [RTE_CRYPTO_AUTH_SHA224] = "sha2-224",
166 [RTE_CRYPTO_AUTH_SHA224_HMAC] = "sha2-224-hmac",
167 [RTE_CRYPTO_AUTH_SHA256] = "sha2-256",
168 [RTE_CRYPTO_AUTH_SHA256_HMAC] = "sha2-256-hmac",
169 [RTE_CRYPTO_AUTH_SHA384] = "sha2-384",
170 [RTE_CRYPTO_AUTH_SHA384_HMAC] = "sha2-384-hmac",
171 [RTE_CRYPTO_AUTH_SHA512] = "sha2-512",
172 [RTE_CRYPTO_AUTH_SHA512_HMAC] = "sha2-512-hmac",
174 [RTE_CRYPTO_AUTH_KASUMI_F9] = "kasumi-f9",
175 [RTE_CRYPTO_AUTH_SNOW3G_UIA2] = "snow3g-uia2",
176 [RTE_CRYPTO_AUTH_ZUC_EIA3] = "zuc-eia3"
180 rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum,
181 const char *algo_string)
185 for (i = 1; i < RTE_DIM(rte_crypto_cipher_algorithm_strings); i++) {
186 if (strcmp(algo_string, rte_crypto_cipher_algorithm_strings[i]) == 0) {
187 *algo_enum = (enum rte_crypto_cipher_algorithm) i;
197 rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum,
198 const char *algo_string)
202 for (i = 1; i < RTE_DIM(rte_crypto_auth_algorithm_strings); i++) {
203 if (strcmp(algo_string, rte_crypto_auth_algorithm_strings[i]) == 0) {
204 *algo_enum = (enum rte_crypto_auth_algorithm) i;
214 * The crypto auth operation strings identifiers.
215 * It could be used in application command line.
218 rte_crypto_auth_operation_strings[] = {
219 [RTE_CRYPTO_AUTH_OP_VERIFY] = "verify",
220 [RTE_CRYPTO_AUTH_OP_GENERATE] = "generate"
223 const struct rte_cryptodev_symmetric_capability *
224 rte_cryptodev_sym_capability_get(uint8_t dev_id,
225 const struct rte_cryptodev_sym_capability_idx *idx)
227 const struct rte_cryptodev_capabilities *capability;
228 struct rte_cryptodev_info dev_info;
231 rte_cryptodev_info_get(dev_id, &dev_info);
233 while ((capability = &dev_info.capabilities[i++])->op !=
234 RTE_CRYPTO_OP_TYPE_UNDEFINED) {
235 if (capability->op != RTE_CRYPTO_OP_TYPE_SYMMETRIC)
238 if (capability->sym.xform_type != idx->type)
241 if (idx->type == RTE_CRYPTO_SYM_XFORM_AUTH &&
242 capability->sym.auth.algo == idx->algo.auth)
243 return &capability->sym;
245 if (idx->type == RTE_CRYPTO_SYM_XFORM_CIPHER &&
246 capability->sym.cipher.algo == idx->algo.cipher)
247 return &capability->sym;
254 #define param_range_check(x, y) \
255 (((x < y.min) || (x > y.max)) || \
256 (y.increment != 0 && (x % y.increment) != 0))
259 rte_cryptodev_sym_capability_check_cipher(
260 const struct rte_cryptodev_symmetric_capability *capability,
261 uint16_t key_size, uint16_t iv_size)
263 if (param_range_check(key_size, capability->cipher.key_size))
266 if (param_range_check(iv_size, capability->cipher.iv_size))
273 rte_cryptodev_sym_capability_check_auth(
274 const struct rte_cryptodev_symmetric_capability *capability,
275 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))
287 if (param_range_check(iv_size, capability->auth.iv_size))
295 rte_cryptodev_get_feature_name(uint64_t flag)
298 case RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO:
299 return "SYMMETRIC_CRYPTO";
300 case RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO:
301 return "ASYMMETRIC_CRYPTO";
302 case RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING:
303 return "SYM_OPERATION_CHAINING";
304 case RTE_CRYPTODEV_FF_CPU_SSE:
306 case RTE_CRYPTODEV_FF_CPU_AVX:
308 case RTE_CRYPTODEV_FF_CPU_AVX2:
310 case RTE_CRYPTODEV_FF_CPU_AESNI:
312 case RTE_CRYPTODEV_FF_HW_ACCELERATED:
313 return "HW_ACCELERATED";
314 case RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER:
315 return "MBUF_SCATTER_GATHER";
316 case RTE_CRYPTODEV_FF_CPU_NEON:
318 case RTE_CRYPTODEV_FF_CPU_ARM_CE:
326 rte_cryptodev_create_vdev(const char *name, const char *args)
328 return rte_vdev_init(name, args);
331 struct rte_cryptodev *
332 rte_cryptodev_pmd_get_dev(uint8_t dev_id)
334 return &rte_cryptodev_globals->devs[dev_id];
337 struct rte_cryptodev *
338 rte_cryptodev_pmd_get_named_dev(const char *name)
340 struct rte_cryptodev *dev;
346 for (i = 0; i < rte_cryptodev_globals->max_devs; i++) {
347 dev = &rte_cryptodev_globals->devs[i];
349 if ((dev->attached == RTE_CRYPTODEV_ATTACHED) &&
350 (strcmp(dev->data->name, name) == 0))
358 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
360 struct rte_cryptodev *dev = NULL;
362 if (dev_id >= rte_cryptodev_globals->nb_devs)
365 dev = rte_cryptodev_pmd_get_dev(dev_id);
366 if (dev->attached != RTE_CRYPTODEV_ATTACHED)
374 rte_cryptodev_get_dev_id(const char *name)
381 for (i = 0; i < rte_cryptodev_globals->nb_devs; i++)
382 if ((strcmp(rte_cryptodev_globals->devs[i].data->name, name)
384 (rte_cryptodev_globals->devs[i].attached ==
385 RTE_CRYPTODEV_ATTACHED))
392 rte_cryptodev_count(void)
394 return rte_cryptodev_globals->nb_devs;
398 rte_cryptodev_count_devtype(enum rte_cryptodev_type type)
400 uint8_t i, dev_count = 0;
402 for (i = 0; i < rte_cryptodev_globals->max_devs; i++)
403 if (rte_cryptodev_globals->devs[i].dev_type == type &&
404 rte_cryptodev_globals->devs[i].attached ==
405 RTE_CRYPTODEV_ATTACHED)
412 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
415 uint8_t i, count = 0;
416 struct rte_cryptodev *devs = rte_cryptodev_globals->devs;
417 uint8_t max_devs = rte_cryptodev_globals->max_devs;
419 for (i = 0; i < max_devs && count < nb_devices; i++) {
421 if (devs[i].attached == RTE_CRYPTODEV_ATTACHED) {
424 cmp = strncmp(devs[i].device->driver->name,
426 strlen(driver_name));
429 devices[count++] = devs[i].data->dev_id;
437 rte_cryptodev_socket_id(uint8_t dev_id)
439 struct rte_cryptodev *dev;
441 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
444 dev = rte_cryptodev_pmd_get_dev(dev_id);
446 return dev->data->socket_id;
450 rte_cryptodev_data_alloc(uint8_t dev_id, struct rte_cryptodev_data **data,
453 char mz_name[RTE_CRYPTODEV_NAME_MAX_LEN];
454 const struct rte_memzone *mz;
457 /* generate memzone name */
458 n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
459 if (n >= (int)sizeof(mz_name))
462 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
463 mz = rte_memzone_reserve(mz_name,
464 sizeof(struct rte_cryptodev_data),
467 mz = rte_memzone_lookup(mz_name);
473 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
474 memset(*data, 0, sizeof(struct rte_cryptodev_data));
480 rte_cryptodev_find_free_device_index(void)
484 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) {
485 if (rte_crypto_devices[dev_id].attached ==
486 RTE_CRYPTODEV_DETACHED)
489 return RTE_CRYPTO_MAX_DEVS;
492 struct rte_cryptodev *
493 rte_cryptodev_pmd_allocate(const char *name, int socket_id)
495 struct rte_cryptodev *cryptodev;
498 if (rte_cryptodev_pmd_get_named_dev(name) != NULL) {
499 CDEV_LOG_ERR("Crypto device with name %s already "
504 dev_id = rte_cryptodev_find_free_device_index();
505 if (dev_id == RTE_CRYPTO_MAX_DEVS) {
506 CDEV_LOG_ERR("Reached maximum number of crypto devices");
510 cryptodev = rte_cryptodev_pmd_get_dev(dev_id);
512 if (cryptodev->data == NULL) {
513 struct rte_cryptodev_data *cryptodev_data =
514 cryptodev_globals.data[dev_id];
516 int retval = rte_cryptodev_data_alloc(dev_id, &cryptodev_data,
519 if (retval < 0 || cryptodev_data == NULL)
522 cryptodev->data = cryptodev_data;
524 snprintf(cryptodev->data->name, RTE_CRYPTODEV_NAME_MAX_LEN,
527 cryptodev->data->dev_id = dev_id;
528 cryptodev->data->socket_id = socket_id;
529 cryptodev->data->dev_started = 0;
531 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
533 cryptodev_globals.nb_devs++;
540 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
544 if (cryptodev == NULL)
547 /* Close device only if device operations have been set */
548 if (cryptodev->dev_ops) {
549 ret = rte_cryptodev_close(cryptodev->data->dev_id);
554 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
555 cryptodev_globals.nb_devs--;
560 rte_cryptodev_queue_pair_count(uint8_t dev_id)
562 struct rte_cryptodev *dev;
564 dev = &rte_crypto_devices[dev_id];
565 return dev->data->nb_queue_pairs;
569 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
572 struct rte_cryptodev_info dev_info;
576 if ((dev == NULL) || (nb_qpairs < 1)) {
577 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
582 CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
583 nb_qpairs, dev->data->dev_id);
585 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
587 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
588 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
590 if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
591 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
592 nb_qpairs, dev->data->dev_id);
596 if (dev->data->queue_pairs == NULL) { /* first time configuration */
597 dev->data->queue_pairs = rte_zmalloc_socket(
598 "cryptodev->queue_pairs",
599 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
600 RTE_CACHE_LINE_SIZE, socket_id);
602 if (dev->data->queue_pairs == NULL) {
603 dev->data->nb_queue_pairs = 0;
604 CDEV_LOG_ERR("failed to get memory for qp meta data, "
609 } else { /* re-configure */
611 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
613 qp = dev->data->queue_pairs;
615 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
618 for (i = nb_qpairs; i < old_nb_queues; i++) {
619 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
624 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
625 RTE_CACHE_LINE_SIZE);
627 CDEV_LOG_ERR("failed to realloc qp meta data,"
628 " nb_queues %u", nb_qpairs);
632 if (nb_qpairs > old_nb_queues) {
633 uint16_t new_qs = nb_qpairs - old_nb_queues;
635 memset(qp + old_nb_queues, 0,
636 sizeof(qp[0]) * new_qs);
639 dev->data->queue_pairs = qp;
642 dev->data->nb_queue_pairs = nb_qpairs;
647 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id)
649 struct rte_cryptodev *dev;
651 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
652 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
656 dev = &rte_crypto_devices[dev_id];
657 if (queue_pair_id >= dev->data->nb_queue_pairs) {
658 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
662 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_start, -ENOTSUP);
664 return dev->dev_ops->queue_pair_start(dev, queue_pair_id);
669 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id)
671 struct rte_cryptodev *dev;
673 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
674 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
678 dev = &rte_crypto_devices[dev_id];
679 if (queue_pair_id >= dev->data->nb_queue_pairs) {
680 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
684 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_stop, -ENOTSUP);
686 return dev->dev_ops->queue_pair_stop(dev, queue_pair_id);
691 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
692 unsigned nb_objs, unsigned obj_cache_size, int socket_id);
695 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
697 struct rte_cryptodev *dev;
700 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
701 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
705 dev = &rte_crypto_devices[dev_id];
707 if (dev->data->dev_started) {
709 "device %d must be stopped to allow configuration", dev_id);
713 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
715 /* Setup new number of queue pairs and reconfigure device. */
716 diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
719 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
724 /* Setup Session mempool for device */
725 diag = rte_cryptodev_sym_session_pool_create(dev,
726 config->session_mp.nb_objs,
727 config->session_mp.cache_size,
732 return (*dev->dev_ops->dev_configure)(dev, config);
737 rte_cryptodev_start(uint8_t dev_id)
739 struct rte_cryptodev *dev;
742 CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
744 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
745 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
749 dev = &rte_crypto_devices[dev_id];
751 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
753 if (dev->data->dev_started != 0) {
754 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
759 diag = (*dev->dev_ops->dev_start)(dev);
761 dev->data->dev_started = 1;
769 rte_cryptodev_stop(uint8_t dev_id)
771 struct rte_cryptodev *dev;
773 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
774 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
778 dev = &rte_crypto_devices[dev_id];
780 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
782 if (dev->data->dev_started == 0) {
783 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
788 (*dev->dev_ops->dev_stop)(dev);
789 dev->data->dev_started = 0;
793 rte_cryptodev_close(uint8_t dev_id)
795 struct rte_cryptodev *dev;
798 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
799 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
803 dev = &rte_crypto_devices[dev_id];
805 /* Device must be stopped before it can be closed */
806 if (dev->data->dev_started == 1) {
807 CDEV_LOG_ERR("Device %u must be stopped before closing",
812 /* We can't close the device if there are outstanding sessions in use */
813 if (dev->data->session_pool != NULL) {
814 if (!rte_mempool_full(dev->data->session_pool)) {
815 CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
816 "has sessions still in use, free "
817 "all sessions before calling close",
823 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
824 retval = (*dev->dev_ops->dev_close)(dev);
833 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
834 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id)
836 struct rte_cryptodev *dev;
838 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
839 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
843 dev = &rte_crypto_devices[dev_id];
844 if (queue_pair_id >= dev->data->nb_queue_pairs) {
845 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
849 if (dev->data->dev_started) {
851 "device %d must be stopped to allow configuration", dev_id);
855 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
857 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
863 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
865 struct rte_cryptodev *dev;
867 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
868 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
873 CDEV_LOG_ERR("Invalid stats ptr");
877 dev = &rte_crypto_devices[dev_id];
878 memset(stats, 0, sizeof(*stats));
880 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
881 (*dev->dev_ops->stats_get)(dev, stats);
886 rte_cryptodev_stats_reset(uint8_t dev_id)
888 struct rte_cryptodev *dev;
890 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
891 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
895 dev = &rte_crypto_devices[dev_id];
897 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
898 (*dev->dev_ops->stats_reset)(dev);
903 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
905 struct rte_cryptodev *dev;
907 if (dev_id >= cryptodev_globals.nb_devs) {
908 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
912 dev = &rte_crypto_devices[dev_id];
914 memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
916 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
917 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
919 dev_info->driver_name = dev->device->driver->name;
924 rte_cryptodev_callback_register(uint8_t dev_id,
925 enum rte_cryptodev_event_type event,
926 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
928 struct rte_cryptodev *dev;
929 struct rte_cryptodev_callback *user_cb;
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 rte_spinlock_lock(&rte_cryptodev_cb_lock);
942 TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
943 if (user_cb->cb_fn == cb_fn &&
944 user_cb->cb_arg == cb_arg &&
945 user_cb->event == event) {
950 /* create a new callback. */
951 if (user_cb == NULL) {
952 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
953 sizeof(struct rte_cryptodev_callback), 0);
954 if (user_cb != NULL) {
955 user_cb->cb_fn = cb_fn;
956 user_cb->cb_arg = cb_arg;
957 user_cb->event = event;
958 TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
962 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
963 return (user_cb == NULL) ? -ENOMEM : 0;
967 rte_cryptodev_callback_unregister(uint8_t dev_id,
968 enum rte_cryptodev_event_type event,
969 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
972 struct rte_cryptodev *dev;
973 struct rte_cryptodev_callback *cb, *next;
978 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
979 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
983 dev = &rte_crypto_devices[dev_id];
984 rte_spinlock_lock(&rte_cryptodev_cb_lock);
987 for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
989 next = TAILQ_NEXT(cb, next);
991 if (cb->cb_fn != cb_fn || cb->event != event ||
992 (cb->cb_arg != (void *)-1 &&
993 cb->cb_arg != cb_arg))
997 * if this callback is not executing right now,
1000 if (cb->active == 0) {
1001 TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
1008 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1013 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
1014 enum rte_cryptodev_event_type event)
1016 struct rte_cryptodev_callback *cb_lst;
1017 struct rte_cryptodev_callback dev_cb;
1019 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1020 TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
1021 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
1025 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1026 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
1028 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1031 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1036 rte_cryptodev_sym_session_init(struct rte_mempool *mp,
1039 __rte_unused unsigned i)
1041 struct rte_cryptodev_sym_session *sess = _sess;
1042 struct rte_cryptodev *dev = opaque_arg;
1044 memset(sess, 0, mp->elt_size);
1046 sess->dev_id = dev->data->dev_id;
1047 sess->dev_type = dev->dev_type;
1050 if (dev->dev_ops->session_initialize)
1051 (*dev->dev_ops->session_initialize)(mp, sess);
1055 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
1056 unsigned nb_objs, unsigned obj_cache_size, int socket_id)
1058 char mp_name[RTE_CRYPTODEV_NAME_MAX_LEN];
1059 unsigned priv_sess_size;
1061 unsigned n = snprintf(mp_name, sizeof(mp_name), "cdev_%d_sess_mp",
1063 if (n > sizeof(mp_name)) {
1064 CDEV_LOG_ERR("Unable to create unique name for session mempool");
1068 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_get_size, -ENOTSUP);
1069 priv_sess_size = (*dev->dev_ops->session_get_size)(dev);
1070 if (priv_sess_size == 0) {
1071 CDEV_LOG_ERR("%s returned and invalid private session size ",
1076 unsigned elt_size = sizeof(struct rte_cryptodev_sym_session) +
1079 dev->data->session_pool = rte_mempool_lookup(mp_name);
1080 if (dev->data->session_pool != NULL) {
1081 if ((dev->data->session_pool->elt_size != elt_size) ||
1082 (dev->data->session_pool->cache_size <
1084 (dev->data->session_pool->size < nb_objs)) {
1086 CDEV_LOG_ERR("%s mempool already exists with different"
1087 " initialization parameters", mp_name);
1088 dev->data->session_pool = NULL;
1092 dev->data->session_pool = rte_mempool_create(
1093 mp_name, /* mempool name */
1094 nb_objs, /* number of elements*/
1095 elt_size, /* element size*/
1096 obj_cache_size, /* Cache size*/
1097 0, /* private data size */
1098 NULL, /* obj initialization constructor */
1099 NULL, /* obj initialization constructor arg */
1100 rte_cryptodev_sym_session_init,
1101 /**< obj constructor*/
1102 dev, /* obj constructor arg */
1103 socket_id, /* socket id */
1106 if (dev->data->session_pool == NULL) {
1107 CDEV_LOG_ERR("%s mempool allocation failed", mp_name);
1112 CDEV_LOG_DEBUG("%s mempool created!", mp_name);
1116 struct rte_cryptodev_sym_session *
1117 rte_cryptodev_sym_session_create(uint8_t dev_id,
1118 struct rte_crypto_sym_xform *xform)
1120 struct rte_cryptodev *dev;
1121 struct rte_cryptodev_sym_session *sess;
1124 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1125 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1129 dev = &rte_crypto_devices[dev_id];
1131 /* Allocate a session structure from the session pool */
1132 if (rte_mempool_get(dev->data->session_pool, &_sess)) {
1133 CDEV_LOG_ERR("Couldn't get object from session mempool");
1139 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_configure, NULL);
1140 if (dev->dev_ops->session_configure(dev, xform, sess->_private) ==
1142 CDEV_LOG_ERR("dev_id %d failed to configure session details",
1145 /* Return session to mempool */
1146 rte_mempool_put(sess->mp, _sess);
1154 rte_cryptodev_queue_pair_attach_sym_session(uint16_t qp_id,
1155 struct rte_cryptodev_sym_session *sess)
1157 struct rte_cryptodev *dev;
1159 if (!rte_cryptodev_pmd_is_valid_dev(sess->dev_id)) {
1160 CDEV_LOG_ERR("Invalid dev_id=%d", sess->dev_id);
1164 dev = &rte_crypto_devices[sess->dev_id];
1166 /* The API is optional, not returning error if driver do not suuport */
1167 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_attach_session, 0);
1168 if (dev->dev_ops->qp_attach_session(dev, qp_id, sess->_private)) {
1169 CDEV_LOG_ERR("dev_id %d failed to attach qp: %d with session",
1170 sess->dev_id, qp_id);
1178 rte_cryptodev_queue_pair_detach_sym_session(uint16_t qp_id,
1179 struct rte_cryptodev_sym_session *sess)
1181 struct rte_cryptodev *dev;
1183 if (!rte_cryptodev_pmd_is_valid_dev(sess->dev_id)) {
1184 CDEV_LOG_ERR("Invalid dev_id=%d", sess->dev_id);
1188 dev = &rte_crypto_devices[sess->dev_id];
1190 /* The API is optional, not returning error if driver do not suuport */
1191 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_detach_session, 0);
1192 if (dev->dev_ops->qp_detach_session(dev, qp_id, sess->_private)) {
1193 CDEV_LOG_ERR("dev_id %d failed to detach qp: %d from session",
1194 sess->dev_id, qp_id);
1200 struct rte_cryptodev_sym_session *
1201 rte_cryptodev_sym_session_free(uint8_t dev_id,
1202 struct rte_cryptodev_sym_session *sess)
1204 struct rte_cryptodev *dev;
1206 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1207 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1211 dev = &rte_crypto_devices[dev_id];
1213 /* Check the session belongs to this device type */
1214 if (sess->dev_type != dev->dev_type)
1217 /* Let device implementation clear session material */
1218 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_clear, sess);
1219 dev->dev_ops->session_clear(dev, (void *)sess->_private);
1221 /* Return session to mempool */
1222 rte_mempool_put(sess->mp, (void *)sess);
1227 /** Initialise rte_crypto_op mempool element */
1229 rte_crypto_op_init(struct rte_mempool *mempool,
1232 __rte_unused unsigned i)
1234 struct rte_crypto_op *op = _op_data;
1235 enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
1237 memset(_op_data, 0, mempool->elt_size);
1239 __rte_crypto_op_reset(op, type);
1241 op->phys_addr = rte_mem_virt2phy(_op_data);
1242 op->mempool = mempool;
1246 struct rte_mempool *
1247 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
1248 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
1251 struct rte_crypto_op_pool_private *priv;
1253 unsigned elt_size = sizeof(struct rte_crypto_op) +
1254 sizeof(struct rte_crypto_sym_op) +
1257 /* lookup mempool in case already allocated */
1258 struct rte_mempool *mp = rte_mempool_lookup(name);
1261 priv = (struct rte_crypto_op_pool_private *)
1262 rte_mempool_get_priv(mp);
1264 if (mp->elt_size != elt_size ||
1265 mp->cache_size < cache_size ||
1266 mp->size < nb_elts ||
1267 priv->priv_size < priv_size) {
1269 CDEV_LOG_ERR("Mempool %s already exists but with "
1270 "incompatible parameters", name);
1276 mp = rte_mempool_create(
1281 sizeof(struct rte_crypto_op_pool_private),
1290 CDEV_LOG_ERR("Failed to create mempool %s", name);
1294 priv = (struct rte_crypto_op_pool_private *)
1295 rte_mempool_get_priv(mp);
1297 priv->priv_size = priv_size;
1304 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix)
1306 struct rte_cryptodev *dev = NULL;
1312 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
1313 int ret = snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
1314 "%s_%u", dev_name_prefix, i);
1319 dev = rte_cryptodev_pmd_get_named_dev(name);