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 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
588 cryptodev_globals.nb_devs++;
595 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
599 if (cryptodev == NULL)
602 /* Close device only if device operations have been set */
603 if (cryptodev->dev_ops) {
604 ret = rte_cryptodev_close(cryptodev->data->dev_id);
609 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
610 cryptodev_globals.nb_devs--;
615 rte_cryptodev_queue_pair_count(uint8_t dev_id)
617 struct rte_cryptodev *dev;
619 dev = &rte_crypto_devices[dev_id];
620 return dev->data->nb_queue_pairs;
624 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
627 struct rte_cryptodev_info dev_info;
631 if ((dev == NULL) || (nb_qpairs < 1)) {
632 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
637 CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
638 nb_qpairs, dev->data->dev_id);
640 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
642 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
643 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
645 if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
646 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
647 nb_qpairs, dev->data->dev_id);
651 if (dev->data->queue_pairs == NULL) { /* first time configuration */
652 dev->data->queue_pairs = rte_zmalloc_socket(
653 "cryptodev->queue_pairs",
654 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
655 RTE_CACHE_LINE_SIZE, socket_id);
657 if (dev->data->queue_pairs == NULL) {
658 dev->data->nb_queue_pairs = 0;
659 CDEV_LOG_ERR("failed to get memory for qp meta data, "
664 } else { /* re-configure */
666 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
668 qp = dev->data->queue_pairs;
670 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
673 for (i = nb_qpairs; i < old_nb_queues; i++) {
674 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
679 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
680 RTE_CACHE_LINE_SIZE);
682 CDEV_LOG_ERR("failed to realloc qp meta data,"
683 " nb_queues %u", nb_qpairs);
687 if (nb_qpairs > old_nb_queues) {
688 uint16_t new_qs = nb_qpairs - old_nb_queues;
690 memset(qp + old_nb_queues, 0,
691 sizeof(qp[0]) * new_qs);
694 dev->data->queue_pairs = qp;
697 dev->data->nb_queue_pairs = nb_qpairs;
702 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id)
704 struct rte_cryptodev *dev;
706 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
707 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
711 dev = &rte_crypto_devices[dev_id];
712 if (queue_pair_id >= dev->data->nb_queue_pairs) {
713 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
717 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_start, -ENOTSUP);
719 return dev->dev_ops->queue_pair_start(dev, queue_pair_id);
724 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id)
726 struct rte_cryptodev *dev;
728 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
729 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
733 dev = &rte_crypto_devices[dev_id];
734 if (queue_pair_id >= dev->data->nb_queue_pairs) {
735 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
739 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_stop, -ENOTSUP);
741 return dev->dev_ops->queue_pair_stop(dev, queue_pair_id);
746 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
748 struct rte_cryptodev *dev;
751 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
752 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
756 dev = &rte_crypto_devices[dev_id];
758 if (dev->data->dev_started) {
760 "device %d must be stopped to allow configuration", dev_id);
764 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
766 /* Setup new number of queue pairs and reconfigure device. */
767 diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
770 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
775 return (*dev->dev_ops->dev_configure)(dev, config);
780 rte_cryptodev_start(uint8_t dev_id)
782 struct rte_cryptodev *dev;
785 CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
787 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
788 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
792 dev = &rte_crypto_devices[dev_id];
794 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
796 if (dev->data->dev_started != 0) {
797 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
802 diag = (*dev->dev_ops->dev_start)(dev);
804 dev->data->dev_started = 1;
812 rte_cryptodev_stop(uint8_t dev_id)
814 struct rte_cryptodev *dev;
816 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
817 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
821 dev = &rte_crypto_devices[dev_id];
823 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
825 if (dev->data->dev_started == 0) {
826 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
831 (*dev->dev_ops->dev_stop)(dev);
832 dev->data->dev_started = 0;
836 rte_cryptodev_close(uint8_t dev_id)
838 struct rte_cryptodev *dev;
841 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
842 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
846 dev = &rte_crypto_devices[dev_id];
848 /* Device must be stopped before it can be closed */
849 if (dev->data->dev_started == 1) {
850 CDEV_LOG_ERR("Device %u must be stopped before closing",
855 /* We can't close the device if there are outstanding sessions in use */
856 if (dev->data->session_pool != NULL) {
857 if (!rte_mempool_full(dev->data->session_pool)) {
858 CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
859 "has sessions still in use, free "
860 "all sessions before calling close",
866 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
867 retval = (*dev->dev_ops->dev_close)(dev);
876 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
877 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id,
878 struct rte_mempool *session_pool)
881 struct rte_cryptodev *dev;
883 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
884 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
888 dev = &rte_crypto_devices[dev_id];
889 if (queue_pair_id >= dev->data->nb_queue_pairs) {
890 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
894 if (dev->data->dev_started) {
896 "device %d must be stopped to allow configuration", dev_id);
900 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
902 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
903 socket_id, session_pool);
908 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
910 struct rte_cryptodev *dev;
912 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
913 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
918 CDEV_LOG_ERR("Invalid stats ptr");
922 dev = &rte_crypto_devices[dev_id];
923 memset(stats, 0, sizeof(*stats));
925 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
926 (*dev->dev_ops->stats_get)(dev, stats);
931 rte_cryptodev_stats_reset(uint8_t dev_id)
933 struct rte_cryptodev *dev;
935 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
936 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
940 dev = &rte_crypto_devices[dev_id];
942 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
943 (*dev->dev_ops->stats_reset)(dev);
948 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
950 struct rte_cryptodev *dev;
952 if (dev_id >= cryptodev_globals.nb_devs) {
953 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
957 dev = &rte_crypto_devices[dev_id];
959 memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
961 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
962 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
964 dev_info->driver_name = dev->device->driver->name;
969 rte_cryptodev_callback_register(uint8_t dev_id,
970 enum rte_cryptodev_event_type event,
971 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
973 struct rte_cryptodev *dev;
974 struct rte_cryptodev_callback *user_cb;
979 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
980 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
984 dev = &rte_crypto_devices[dev_id];
985 rte_spinlock_lock(&rte_cryptodev_cb_lock);
987 TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
988 if (user_cb->cb_fn == cb_fn &&
989 user_cb->cb_arg == cb_arg &&
990 user_cb->event == event) {
995 /* create a new callback. */
996 if (user_cb == NULL) {
997 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
998 sizeof(struct rte_cryptodev_callback), 0);
999 if (user_cb != NULL) {
1000 user_cb->cb_fn = cb_fn;
1001 user_cb->cb_arg = cb_arg;
1002 user_cb->event = event;
1003 TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
1007 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1008 return (user_cb == NULL) ? -ENOMEM : 0;
1012 rte_cryptodev_callback_unregister(uint8_t dev_id,
1013 enum rte_cryptodev_event_type event,
1014 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1017 struct rte_cryptodev *dev;
1018 struct rte_cryptodev_callback *cb, *next;
1023 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1024 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1028 dev = &rte_crypto_devices[dev_id];
1029 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1032 for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
1034 next = TAILQ_NEXT(cb, next);
1036 if (cb->cb_fn != cb_fn || cb->event != event ||
1037 (cb->cb_arg != (void *)-1 &&
1038 cb->cb_arg != cb_arg))
1042 * if this callback is not executing right now,
1045 if (cb->active == 0) {
1046 TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
1053 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1058 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
1059 enum rte_cryptodev_event_type event)
1061 struct rte_cryptodev_callback *cb_lst;
1062 struct rte_cryptodev_callback dev_cb;
1064 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1065 TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
1066 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
1070 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1071 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
1073 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1076 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1081 rte_cryptodev_sym_session_init(uint8_t dev_id,
1082 struct rte_cryptodev_sym_session *sess,
1083 struct rte_crypto_sym_xform *xforms,
1084 struct rte_mempool *mp)
1086 struct rte_cryptodev *dev;
1090 dev = rte_cryptodev_pmd_get_dev(dev_id);
1092 if (sess == NULL || xforms == NULL || dev == NULL)
1095 index = dev->driver_id;
1097 if (sess->sess_private_data[index] == NULL) {
1098 ret = dev->dev_ops->session_configure(dev, xforms, sess, mp);
1101 "dev_id %d failed to configure session details",
1110 struct rte_cryptodev_sym_session *
1111 rte_cryptodev_sym_session_create(struct rte_mempool *mp)
1113 struct rte_cryptodev_sym_session *sess;
1115 /* Allocate a session structure from the session pool */
1116 if (rte_mempool_get(mp, (void *)&sess)) {
1117 CDEV_LOG_ERR("couldn't get object from session mempool");
1121 /* Clear device session pointer */
1122 memset(sess, 0, (sizeof(void *) * nb_drivers));
1128 rte_cryptodev_queue_pair_attach_sym_session(uint8_t dev_id, uint16_t qp_id,
1129 struct rte_cryptodev_sym_session *sess)
1131 struct rte_cryptodev *dev;
1133 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1134 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1138 dev = &rte_crypto_devices[dev_id];
1140 /* The API is optional, not returning error if driver do not suuport */
1141 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_attach_session, 0);
1143 void *sess_priv = get_session_private_data(sess, dev->driver_id);
1145 if (dev->dev_ops->qp_attach_session(dev, qp_id, sess_priv)) {
1146 CDEV_LOG_ERR("dev_id %d failed to attach qp: %d with session",
1155 rte_cryptodev_queue_pair_detach_sym_session(uint8_t dev_id, uint16_t qp_id,
1156 struct rte_cryptodev_sym_session *sess)
1158 struct rte_cryptodev *dev;
1160 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1161 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1165 dev = &rte_crypto_devices[dev_id];
1167 /* The API is optional, not returning error if driver do not suuport */
1168 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_detach_session, 0);
1170 void *sess_priv = get_session_private_data(sess, dev->driver_id);
1172 if (dev->dev_ops->qp_detach_session(dev, qp_id, sess_priv)) {
1173 CDEV_LOG_ERR("dev_id %d failed to detach qp: %d from session",
1182 rte_cryptodev_sym_session_clear(uint8_t dev_id,
1183 struct rte_cryptodev_sym_session *sess)
1185 struct rte_cryptodev *dev;
1187 dev = rte_cryptodev_pmd_get_dev(dev_id);
1189 if (dev == NULL || sess == NULL)
1192 dev->dev_ops->session_clear(dev, sess);
1198 rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess)
1202 struct rte_mempool *sess_mp;
1207 /* Check that all device private data has been freed */
1208 for (i = 0; i < nb_drivers; i++) {
1209 sess_priv = get_session_private_data(sess, i);
1210 if (sess_priv != NULL)
1214 /* Return session to mempool */
1215 sess_mp = rte_mempool_from_obj(sess);
1216 rte_mempool_put(sess_mp, sess);
1222 rte_cryptodev_get_header_session_size(void)
1225 * Header contains pointers to the private data
1226 * of all registered drivers
1228 return (sizeof(void *) * nb_drivers);
1232 rte_cryptodev_get_private_session_size(uint8_t dev_id)
1234 struct rte_cryptodev *dev;
1235 unsigned int header_size = sizeof(void *) * nb_drivers;
1236 unsigned int priv_sess_size;
1238 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
1241 dev = rte_cryptodev_pmd_get_dev(dev_id);
1243 if (*dev->dev_ops->session_get_size == NULL)
1246 priv_sess_size = (*dev->dev_ops->session_get_size)(dev);
1249 * If size is less than session header size,
1250 * return the latter, as this guarantees that
1251 * sessionless operations will work
1253 if (priv_sess_size < header_size)
1256 return priv_sess_size;
1260 /** Initialise rte_crypto_op mempool element */
1262 rte_crypto_op_init(struct rte_mempool *mempool,
1265 __rte_unused unsigned i)
1267 struct rte_crypto_op *op = _op_data;
1268 enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
1270 memset(_op_data, 0, mempool->elt_size);
1272 __rte_crypto_op_reset(op, type);
1274 op->phys_addr = rte_mem_virt2phy(_op_data);
1275 op->mempool = mempool;
1279 struct rte_mempool *
1280 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
1281 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
1284 struct rte_crypto_op_pool_private *priv;
1286 unsigned elt_size = sizeof(struct rte_crypto_op) +
1287 sizeof(struct rte_crypto_sym_op) +
1290 /* lookup mempool in case already allocated */
1291 struct rte_mempool *mp = rte_mempool_lookup(name);
1294 priv = (struct rte_crypto_op_pool_private *)
1295 rte_mempool_get_priv(mp);
1297 if (mp->elt_size != elt_size ||
1298 mp->cache_size < cache_size ||
1299 mp->size < nb_elts ||
1300 priv->priv_size < priv_size) {
1302 CDEV_LOG_ERR("Mempool %s already exists but with "
1303 "incompatible parameters", name);
1309 mp = rte_mempool_create(
1314 sizeof(struct rte_crypto_op_pool_private),
1323 CDEV_LOG_ERR("Failed to create mempool %s", name);
1327 priv = (struct rte_crypto_op_pool_private *)
1328 rte_mempool_get_priv(mp);
1330 priv->priv_size = priv_size;
1337 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix)
1339 struct rte_cryptodev *dev = NULL;
1345 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
1346 int ret = snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
1347 "%s_%u", dev_name_prefix, i);
1352 dev = rte_cryptodev_pmd_get_named_dev(name);
1360 TAILQ_HEAD(cryptodev_driver_list, cryptodev_driver);
1362 static struct cryptodev_driver_list cryptodev_driver_list =
1363 TAILQ_HEAD_INITIALIZER(cryptodev_driver_list);
1365 struct cryptodev_driver {
1366 TAILQ_ENTRY(cryptodev_driver) next; /**< Next in list. */
1367 const struct rte_driver *driver;
1372 rte_cryptodev_driver_id_get(const char *name)
1374 struct cryptodev_driver *driver;
1375 const char *driver_name;
1378 RTE_LOG(DEBUG, CRYPTODEV, "name pointer NULL");
1382 TAILQ_FOREACH(driver, &cryptodev_driver_list, next) {
1383 driver_name = driver->driver->name;
1384 if (strncmp(driver_name, name, strlen(driver_name)) == 0)
1391 rte_cryptodev_driver_name_get(uint8_t driver_id)
1393 struct cryptodev_driver *driver;
1395 TAILQ_FOREACH(driver, &cryptodev_driver_list, next)
1396 if (driver->id == driver_id)
1397 return driver->driver->name;
1402 rte_cryptodev_allocate_driver(const struct rte_driver *drv)
1404 struct cryptodev_driver *driver;
1406 driver = malloc(sizeof(*driver));
1407 driver->driver = drv;
1408 driver->id = nb_drivers;
1410 TAILQ_INSERT_TAIL(&cryptodev_driver_list, driver, next);
1412 return nb_drivers++;