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)
277 if (param_range_check(key_size, capability->auth.key_size))
280 if (param_range_check(digest_size, capability->auth.digest_size))
283 if (param_range_check(aad_size, capability->auth.aad_size))
291 rte_cryptodev_get_feature_name(uint64_t flag)
294 case RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO:
295 return "SYMMETRIC_CRYPTO";
296 case RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO:
297 return "ASYMMETRIC_CRYPTO";
298 case RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING:
299 return "SYM_OPERATION_CHAINING";
300 case RTE_CRYPTODEV_FF_CPU_SSE:
302 case RTE_CRYPTODEV_FF_CPU_AVX:
304 case RTE_CRYPTODEV_FF_CPU_AVX2:
306 case RTE_CRYPTODEV_FF_CPU_AESNI:
308 case RTE_CRYPTODEV_FF_HW_ACCELERATED:
309 return "HW_ACCELERATED";
310 case RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER:
311 return "MBUF_SCATTER_GATHER";
312 case RTE_CRYPTODEV_FF_CPU_NEON:
314 case RTE_CRYPTODEV_FF_CPU_ARM_CE:
322 rte_cryptodev_create_vdev(const char *name, const char *args)
324 return rte_vdev_init(name, args);
327 struct rte_cryptodev *
328 rte_cryptodev_pmd_get_dev(uint8_t dev_id)
330 return &rte_cryptodev_globals->devs[dev_id];
333 struct rte_cryptodev *
334 rte_cryptodev_pmd_get_named_dev(const char *name)
336 struct rte_cryptodev *dev;
342 for (i = 0; i < rte_cryptodev_globals->max_devs; i++) {
343 dev = &rte_cryptodev_globals->devs[i];
345 if ((dev->attached == RTE_CRYPTODEV_ATTACHED) &&
346 (strcmp(dev->data->name, name) == 0))
354 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
356 struct rte_cryptodev *dev = NULL;
358 if (dev_id >= rte_cryptodev_globals->nb_devs)
361 dev = rte_cryptodev_pmd_get_dev(dev_id);
362 if (dev->attached != RTE_CRYPTODEV_ATTACHED)
370 rte_cryptodev_get_dev_id(const char *name)
377 for (i = 0; i < rte_cryptodev_globals->nb_devs; i++)
378 if ((strcmp(rte_cryptodev_globals->devs[i].data->name, name)
380 (rte_cryptodev_globals->devs[i].attached ==
381 RTE_CRYPTODEV_ATTACHED))
388 rte_cryptodev_count(void)
390 return rte_cryptodev_globals->nb_devs;
394 rte_cryptodev_count_devtype(enum rte_cryptodev_type type)
396 uint8_t i, dev_count = 0;
398 for (i = 0; i < rte_cryptodev_globals->max_devs; i++)
399 if (rte_cryptodev_globals->devs[i].dev_type == type &&
400 rte_cryptodev_globals->devs[i].attached ==
401 RTE_CRYPTODEV_ATTACHED)
408 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
411 uint8_t i, count = 0;
412 struct rte_cryptodev *devs = rte_cryptodev_globals->devs;
413 uint8_t max_devs = rte_cryptodev_globals->max_devs;
415 for (i = 0; i < max_devs && count < nb_devices; i++) {
417 if (devs[i].attached == RTE_CRYPTODEV_ATTACHED) {
420 cmp = strncmp(devs[i].device->driver->name,
422 strlen(driver_name));
425 devices[count++] = devs[i].data->dev_id;
433 rte_cryptodev_socket_id(uint8_t dev_id)
435 struct rte_cryptodev *dev;
437 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
440 dev = rte_cryptodev_pmd_get_dev(dev_id);
442 return dev->data->socket_id;
446 rte_cryptodev_data_alloc(uint8_t dev_id, struct rte_cryptodev_data **data,
449 char mz_name[RTE_CRYPTODEV_NAME_MAX_LEN];
450 const struct rte_memzone *mz;
453 /* generate memzone name */
454 n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
455 if (n >= (int)sizeof(mz_name))
458 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
459 mz = rte_memzone_reserve(mz_name,
460 sizeof(struct rte_cryptodev_data),
463 mz = rte_memzone_lookup(mz_name);
469 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
470 memset(*data, 0, sizeof(struct rte_cryptodev_data));
476 rte_cryptodev_find_free_device_index(void)
480 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) {
481 if (rte_crypto_devices[dev_id].attached ==
482 RTE_CRYPTODEV_DETACHED)
485 return RTE_CRYPTO_MAX_DEVS;
488 struct rte_cryptodev *
489 rte_cryptodev_pmd_allocate(const char *name, int socket_id)
491 struct rte_cryptodev *cryptodev;
494 if (rte_cryptodev_pmd_get_named_dev(name) != NULL) {
495 CDEV_LOG_ERR("Crypto device with name %s already "
500 dev_id = rte_cryptodev_find_free_device_index();
501 if (dev_id == RTE_CRYPTO_MAX_DEVS) {
502 CDEV_LOG_ERR("Reached maximum number of crypto devices");
506 cryptodev = rte_cryptodev_pmd_get_dev(dev_id);
508 if (cryptodev->data == NULL) {
509 struct rte_cryptodev_data *cryptodev_data =
510 cryptodev_globals.data[dev_id];
512 int retval = rte_cryptodev_data_alloc(dev_id, &cryptodev_data,
515 if (retval < 0 || cryptodev_data == NULL)
518 cryptodev->data = cryptodev_data;
520 snprintf(cryptodev->data->name, RTE_CRYPTODEV_NAME_MAX_LEN,
523 cryptodev->data->dev_id = dev_id;
524 cryptodev->data->socket_id = socket_id;
525 cryptodev->data->dev_started = 0;
527 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
529 cryptodev_globals.nb_devs++;
536 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
540 if (cryptodev == NULL)
543 /* Close device only if device operations have been set */
544 if (cryptodev->dev_ops) {
545 ret = rte_cryptodev_close(cryptodev->data->dev_id);
550 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
551 cryptodev_globals.nb_devs--;
556 rte_cryptodev_queue_pair_count(uint8_t dev_id)
558 struct rte_cryptodev *dev;
560 dev = &rte_crypto_devices[dev_id];
561 return dev->data->nb_queue_pairs;
565 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
568 struct rte_cryptodev_info dev_info;
572 if ((dev == NULL) || (nb_qpairs < 1)) {
573 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
578 CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
579 nb_qpairs, dev->data->dev_id);
581 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
583 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
584 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
586 if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
587 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
588 nb_qpairs, dev->data->dev_id);
592 if (dev->data->queue_pairs == NULL) { /* first time configuration */
593 dev->data->queue_pairs = rte_zmalloc_socket(
594 "cryptodev->queue_pairs",
595 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
596 RTE_CACHE_LINE_SIZE, socket_id);
598 if (dev->data->queue_pairs == NULL) {
599 dev->data->nb_queue_pairs = 0;
600 CDEV_LOG_ERR("failed to get memory for qp meta data, "
605 } else { /* re-configure */
607 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
609 qp = dev->data->queue_pairs;
611 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
614 for (i = nb_qpairs; i < old_nb_queues; i++) {
615 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
620 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
621 RTE_CACHE_LINE_SIZE);
623 CDEV_LOG_ERR("failed to realloc qp meta data,"
624 " nb_queues %u", nb_qpairs);
628 if (nb_qpairs > old_nb_queues) {
629 uint16_t new_qs = nb_qpairs - old_nb_queues;
631 memset(qp + old_nb_queues, 0,
632 sizeof(qp[0]) * new_qs);
635 dev->data->queue_pairs = qp;
638 dev->data->nb_queue_pairs = nb_qpairs;
643 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id)
645 struct rte_cryptodev *dev;
647 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
648 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
652 dev = &rte_crypto_devices[dev_id];
653 if (queue_pair_id >= dev->data->nb_queue_pairs) {
654 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
658 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_start, -ENOTSUP);
660 return dev->dev_ops->queue_pair_start(dev, queue_pair_id);
665 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id)
667 struct rte_cryptodev *dev;
669 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
670 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
674 dev = &rte_crypto_devices[dev_id];
675 if (queue_pair_id >= dev->data->nb_queue_pairs) {
676 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
680 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_stop, -ENOTSUP);
682 return dev->dev_ops->queue_pair_stop(dev, queue_pair_id);
687 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
688 unsigned nb_objs, unsigned obj_cache_size, int socket_id);
691 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
693 struct rte_cryptodev *dev;
696 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
697 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
701 dev = &rte_crypto_devices[dev_id];
703 if (dev->data->dev_started) {
705 "device %d must be stopped to allow configuration", dev_id);
709 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
711 /* Setup new number of queue pairs and reconfigure device. */
712 diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
715 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
720 /* Setup Session mempool for device */
721 diag = rte_cryptodev_sym_session_pool_create(dev,
722 config->session_mp.nb_objs,
723 config->session_mp.cache_size,
728 return (*dev->dev_ops->dev_configure)(dev, config);
733 rte_cryptodev_start(uint8_t dev_id)
735 struct rte_cryptodev *dev;
738 CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
740 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
741 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
745 dev = &rte_crypto_devices[dev_id];
747 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
749 if (dev->data->dev_started != 0) {
750 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
755 diag = (*dev->dev_ops->dev_start)(dev);
757 dev->data->dev_started = 1;
765 rte_cryptodev_stop(uint8_t dev_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];
776 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
778 if (dev->data->dev_started == 0) {
779 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
784 dev->data->dev_started = 0;
785 (*dev->dev_ops->dev_stop)(dev);
789 rte_cryptodev_close(uint8_t dev_id)
791 struct rte_cryptodev *dev;
794 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
795 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
799 dev = &rte_crypto_devices[dev_id];
801 /* Device must be stopped before it can be closed */
802 if (dev->data->dev_started == 1) {
803 CDEV_LOG_ERR("Device %u must be stopped before closing",
808 /* We can't close the device if there are outstanding sessions in use */
809 if (dev->data->session_pool != NULL) {
810 if (!rte_mempool_full(dev->data->session_pool)) {
811 CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
812 "has sessions still in use, free "
813 "all sessions before calling close",
819 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
820 retval = (*dev->dev_ops->dev_close)(dev);
829 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
830 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id)
832 struct rte_cryptodev *dev;
834 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
835 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
839 dev = &rte_crypto_devices[dev_id];
840 if (queue_pair_id >= dev->data->nb_queue_pairs) {
841 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
845 if (dev->data->dev_started) {
847 "device %d must be stopped to allow configuration", dev_id);
851 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
853 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
859 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
861 struct rte_cryptodev *dev;
863 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
864 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
869 CDEV_LOG_ERR("Invalid stats ptr");
873 dev = &rte_crypto_devices[dev_id];
874 memset(stats, 0, sizeof(*stats));
876 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
877 (*dev->dev_ops->stats_get)(dev, stats);
882 rte_cryptodev_stats_reset(uint8_t dev_id)
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];
893 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
894 (*dev->dev_ops->stats_reset)(dev);
899 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
901 struct rte_cryptodev *dev;
903 if (dev_id >= cryptodev_globals.nb_devs) {
904 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
908 dev = &rte_crypto_devices[dev_id];
910 memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
912 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
913 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
915 dev_info->driver_name = dev->device->driver->name;
920 rte_cryptodev_callback_register(uint8_t dev_id,
921 enum rte_cryptodev_event_type event,
922 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
924 struct rte_cryptodev *dev;
925 struct rte_cryptodev_callback *user_cb;
930 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
931 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
935 dev = &rte_crypto_devices[dev_id];
936 rte_spinlock_lock(&rte_cryptodev_cb_lock);
938 TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
939 if (user_cb->cb_fn == cb_fn &&
940 user_cb->cb_arg == cb_arg &&
941 user_cb->event == event) {
946 /* create a new callback. */
947 if (user_cb == NULL) {
948 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
949 sizeof(struct rte_cryptodev_callback), 0);
950 if (user_cb != NULL) {
951 user_cb->cb_fn = cb_fn;
952 user_cb->cb_arg = cb_arg;
953 user_cb->event = event;
954 TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
958 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
959 return (user_cb == NULL) ? -ENOMEM : 0;
963 rte_cryptodev_callback_unregister(uint8_t dev_id,
964 enum rte_cryptodev_event_type event,
965 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
968 struct rte_cryptodev *dev;
969 struct rte_cryptodev_callback *cb, *next;
974 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
975 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
979 dev = &rte_crypto_devices[dev_id];
980 rte_spinlock_lock(&rte_cryptodev_cb_lock);
983 for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
985 next = TAILQ_NEXT(cb, next);
987 if (cb->cb_fn != cb_fn || cb->event != event ||
988 (cb->cb_arg != (void *)-1 &&
989 cb->cb_arg != cb_arg))
993 * if this callback is not executing right now,
996 if (cb->active == 0) {
997 TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
1004 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1009 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
1010 enum rte_cryptodev_event_type event)
1012 struct rte_cryptodev_callback *cb_lst;
1013 struct rte_cryptodev_callback dev_cb;
1015 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1016 TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
1017 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
1021 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1022 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
1024 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1027 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1032 rte_cryptodev_sym_session_init(struct rte_mempool *mp,
1035 __rte_unused unsigned i)
1037 struct rte_cryptodev_sym_session *sess = _sess;
1038 struct rte_cryptodev *dev = opaque_arg;
1040 memset(sess, 0, mp->elt_size);
1042 sess->dev_id = dev->data->dev_id;
1043 sess->dev_type = dev->dev_type;
1046 if (dev->dev_ops->session_initialize)
1047 (*dev->dev_ops->session_initialize)(mp, sess);
1051 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
1052 unsigned nb_objs, unsigned obj_cache_size, int socket_id)
1054 char mp_name[RTE_CRYPTODEV_NAME_MAX_LEN];
1055 unsigned priv_sess_size;
1057 unsigned n = snprintf(mp_name, sizeof(mp_name), "cdev_%d_sess_mp",
1059 if (n > sizeof(mp_name)) {
1060 CDEV_LOG_ERR("Unable to create unique name for session mempool");
1064 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_get_size, -ENOTSUP);
1065 priv_sess_size = (*dev->dev_ops->session_get_size)(dev);
1066 if (priv_sess_size == 0) {
1067 CDEV_LOG_ERR("%s returned and invalid private session size ",
1072 unsigned elt_size = sizeof(struct rte_cryptodev_sym_session) +
1075 dev->data->session_pool = rte_mempool_lookup(mp_name);
1076 if (dev->data->session_pool != NULL) {
1077 if ((dev->data->session_pool->elt_size != elt_size) ||
1078 (dev->data->session_pool->cache_size <
1080 (dev->data->session_pool->size < nb_objs)) {
1082 CDEV_LOG_ERR("%s mempool already exists with different"
1083 " initialization parameters", mp_name);
1084 dev->data->session_pool = NULL;
1088 dev->data->session_pool = rte_mempool_create(
1089 mp_name, /* mempool name */
1090 nb_objs, /* number of elements*/
1091 elt_size, /* element size*/
1092 obj_cache_size, /* Cache size*/
1093 0, /* private data size */
1094 NULL, /* obj initialization constructor */
1095 NULL, /* obj initialization constructor arg */
1096 rte_cryptodev_sym_session_init,
1097 /**< obj constructor*/
1098 dev, /* obj constructor arg */
1099 socket_id, /* socket id */
1102 if (dev->data->session_pool == NULL) {
1103 CDEV_LOG_ERR("%s mempool allocation failed", mp_name);
1108 CDEV_LOG_DEBUG("%s mempool created!", mp_name);
1112 struct rte_cryptodev_sym_session *
1113 rte_cryptodev_sym_session_create(uint8_t dev_id,
1114 struct rte_crypto_sym_xform *xform)
1116 struct rte_cryptodev *dev;
1117 struct rte_cryptodev_sym_session *sess;
1120 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1121 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1125 dev = &rte_crypto_devices[dev_id];
1127 /* Allocate a session structure from the session pool */
1128 if (rte_mempool_get(dev->data->session_pool, &_sess)) {
1129 CDEV_LOG_ERR("Couldn't get object from session mempool");
1135 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_configure, NULL);
1136 if (dev->dev_ops->session_configure(dev, xform, sess->_private) ==
1138 CDEV_LOG_ERR("dev_id %d failed to configure session details",
1141 /* Return session to mempool */
1142 rte_mempool_put(sess->mp, _sess);
1150 rte_cryptodev_queue_pair_attach_sym_session(uint16_t qp_id,
1151 struct rte_cryptodev_sym_session *sess)
1153 struct rte_cryptodev *dev;
1155 if (!rte_cryptodev_pmd_is_valid_dev(sess->dev_id)) {
1156 CDEV_LOG_ERR("Invalid dev_id=%d", sess->dev_id);
1160 dev = &rte_crypto_devices[sess->dev_id];
1162 /* The API is optional, not returning error if driver do not suuport */
1163 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_attach_session, 0);
1164 if (dev->dev_ops->qp_attach_session(dev, qp_id, sess->_private)) {
1165 CDEV_LOG_ERR("dev_id %d failed to attach qp: %d with session",
1166 sess->dev_id, qp_id);
1174 rte_cryptodev_queue_pair_detach_sym_session(uint16_t qp_id,
1175 struct rte_cryptodev_sym_session *sess)
1177 struct rte_cryptodev *dev;
1179 if (!rte_cryptodev_pmd_is_valid_dev(sess->dev_id)) {
1180 CDEV_LOG_ERR("Invalid dev_id=%d", sess->dev_id);
1184 dev = &rte_crypto_devices[sess->dev_id];
1186 /* The API is optional, not returning error if driver do not suuport */
1187 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_detach_session, 0);
1188 if (dev->dev_ops->qp_detach_session(dev, qp_id, sess->_private)) {
1189 CDEV_LOG_ERR("dev_id %d failed to detach qp: %d from session",
1190 sess->dev_id, qp_id);
1196 struct rte_cryptodev_sym_session *
1197 rte_cryptodev_sym_session_free(uint8_t dev_id,
1198 struct rte_cryptodev_sym_session *sess)
1200 struct rte_cryptodev *dev;
1202 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1203 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1207 dev = &rte_crypto_devices[dev_id];
1209 /* Check the session belongs to this device type */
1210 if (sess->dev_type != dev->dev_type)
1213 /* Let device implementation clear session material */
1214 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_clear, sess);
1215 dev->dev_ops->session_clear(dev, (void *)sess->_private);
1217 /* Return session to mempool */
1218 rte_mempool_put(sess->mp, (void *)sess);
1223 /** Initialise rte_crypto_op mempool element */
1225 rte_crypto_op_init(struct rte_mempool *mempool,
1228 __rte_unused unsigned i)
1230 struct rte_crypto_op *op = _op_data;
1231 enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
1233 memset(_op_data, 0, mempool->elt_size);
1235 __rte_crypto_op_reset(op, type);
1237 op->phys_addr = rte_mem_virt2phy(_op_data);
1238 op->mempool = mempool;
1242 struct rte_mempool *
1243 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
1244 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
1247 struct rte_crypto_op_pool_private *priv;
1249 unsigned elt_size = sizeof(struct rte_crypto_op) +
1250 sizeof(struct rte_crypto_sym_op) +
1253 /* lookup mempool in case already allocated */
1254 struct rte_mempool *mp = rte_mempool_lookup(name);
1257 priv = (struct rte_crypto_op_pool_private *)
1258 rte_mempool_get_priv(mp);
1260 if (mp->elt_size != elt_size ||
1261 mp->cache_size < cache_size ||
1262 mp->size < nb_elts ||
1263 priv->priv_size < priv_size) {
1265 CDEV_LOG_ERR("Mempool %s already exists but with "
1266 "incompatible parameters", name);
1272 mp = rte_mempool_create(
1277 sizeof(struct rte_crypto_op_pool_private),
1286 CDEV_LOG_ERR("Failed to create mempool %s", name);
1290 priv = (struct rte_crypto_op_pool_private *)
1291 rte_mempool_get_priv(mp);
1293 priv->priv_size = priv_size;
1300 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix)
1302 struct rte_cryptodev *dev = NULL;
1308 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
1309 int ret = snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
1310 "%s_%u", dev_name_prefix, i);
1315 dev = rte_cryptodev_pmd_get_named_dev(name);