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 * The crypto AEAD algorithm strings identifiers.
181 * It could be used in application command line.
184 rte_crypto_aead_algorithm_strings[] = {
185 [RTE_CRYPTO_AEAD_AES_CCM] = "aes-ccm",
186 [RTE_CRYPTO_AEAD_AES_GCM] = "aes-gcm",
190 * The crypto AEAD operation strings identifiers.
191 * It could be used in application command line.
194 rte_crypto_aead_operation_strings[] = {
195 [RTE_CRYPTO_AEAD_OP_ENCRYPT] = "encrypt",
196 [RTE_CRYPTO_AEAD_OP_DECRYPT] = "decrypt"
200 rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum,
201 const char *algo_string)
205 for (i = 1; i < RTE_DIM(rte_crypto_cipher_algorithm_strings); i++) {
206 if (strcmp(algo_string, rte_crypto_cipher_algorithm_strings[i]) == 0) {
207 *algo_enum = (enum rte_crypto_cipher_algorithm) i;
217 rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum,
218 const char *algo_string)
222 for (i = 1; i < RTE_DIM(rte_crypto_auth_algorithm_strings); i++) {
223 if (strcmp(algo_string, rte_crypto_auth_algorithm_strings[i]) == 0) {
224 *algo_enum = (enum rte_crypto_auth_algorithm) i;
234 rte_cryptodev_get_aead_algo_enum(enum rte_crypto_aead_algorithm *algo_enum,
235 const char *algo_string)
239 for (i = 1; i < RTE_DIM(rte_crypto_aead_algorithm_strings); i++) {
240 if (strcmp(algo_string, rte_crypto_aead_algorithm_strings[i]) == 0) {
241 *algo_enum = (enum rte_crypto_aead_algorithm) i;
251 * The crypto auth operation strings identifiers.
252 * It could be used in application command line.
255 rte_crypto_auth_operation_strings[] = {
256 [RTE_CRYPTO_AUTH_OP_VERIFY] = "verify",
257 [RTE_CRYPTO_AUTH_OP_GENERATE] = "generate"
260 const struct rte_cryptodev_symmetric_capability *
261 rte_cryptodev_sym_capability_get(uint8_t dev_id,
262 const struct rte_cryptodev_sym_capability_idx *idx)
264 const struct rte_cryptodev_capabilities *capability;
265 struct rte_cryptodev_info dev_info;
268 rte_cryptodev_info_get(dev_id, &dev_info);
270 while ((capability = &dev_info.capabilities[i++])->op !=
271 RTE_CRYPTO_OP_TYPE_UNDEFINED) {
272 if (capability->op != RTE_CRYPTO_OP_TYPE_SYMMETRIC)
275 if (capability->sym.xform_type != idx->type)
278 if (idx->type == RTE_CRYPTO_SYM_XFORM_AUTH &&
279 capability->sym.auth.algo == idx->algo.auth)
280 return &capability->sym;
282 if (idx->type == RTE_CRYPTO_SYM_XFORM_CIPHER &&
283 capability->sym.cipher.algo == idx->algo.cipher)
284 return &capability->sym;
286 if (idx->type == RTE_CRYPTO_SYM_XFORM_AEAD &&
287 capability->sym.aead.algo == idx->algo.aead)
288 return &capability->sym;
295 #define param_range_check(x, y) \
296 (((x < y.min) || (x > y.max)) || \
297 (y.increment != 0 && (x % y.increment) != 0))
300 rte_cryptodev_sym_capability_check_cipher(
301 const struct rte_cryptodev_symmetric_capability *capability,
302 uint16_t key_size, uint16_t iv_size)
304 if (param_range_check(key_size, capability->cipher.key_size))
307 if (param_range_check(iv_size, capability->cipher.iv_size))
314 rte_cryptodev_sym_capability_check_auth(
315 const struct rte_cryptodev_symmetric_capability *capability,
316 uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
319 if (param_range_check(key_size, capability->auth.key_size))
322 if (param_range_check(digest_size, capability->auth.digest_size))
325 if (param_range_check(aad_size, capability->auth.aad_size))
328 if (param_range_check(iv_size, capability->auth.iv_size))
335 rte_cryptodev_sym_capability_check_aead(
336 const struct rte_cryptodev_symmetric_capability *capability,
337 uint16_t key_size, uint16_t digest_size, uint16_t aad_size,
340 if (param_range_check(key_size, capability->aead.key_size))
343 if (param_range_check(digest_size, capability->aead.digest_size))
346 if (param_range_check(aad_size, capability->aead.aad_size))
349 if (param_range_check(iv_size, capability->aead.iv_size))
356 rte_cryptodev_get_feature_name(uint64_t flag)
359 case RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO:
360 return "SYMMETRIC_CRYPTO";
361 case RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO:
362 return "ASYMMETRIC_CRYPTO";
363 case RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING:
364 return "SYM_OPERATION_CHAINING";
365 case RTE_CRYPTODEV_FF_CPU_SSE:
367 case RTE_CRYPTODEV_FF_CPU_AVX:
369 case RTE_CRYPTODEV_FF_CPU_AVX2:
371 case RTE_CRYPTODEV_FF_CPU_AESNI:
373 case RTE_CRYPTODEV_FF_HW_ACCELERATED:
374 return "HW_ACCELERATED";
375 case RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER:
376 return "MBUF_SCATTER_GATHER";
377 case RTE_CRYPTODEV_FF_CPU_NEON:
379 case RTE_CRYPTODEV_FF_CPU_ARM_CE:
387 rte_cryptodev_create_vdev(const char *name, const char *args)
389 return rte_vdev_init(name, args);
392 struct rte_cryptodev *
393 rte_cryptodev_pmd_get_dev(uint8_t dev_id)
395 return &rte_cryptodev_globals->devs[dev_id];
398 struct rte_cryptodev *
399 rte_cryptodev_pmd_get_named_dev(const char *name)
401 struct rte_cryptodev *dev;
407 for (i = 0; i < rte_cryptodev_globals->max_devs; i++) {
408 dev = &rte_cryptodev_globals->devs[i];
410 if ((dev->attached == RTE_CRYPTODEV_ATTACHED) &&
411 (strcmp(dev->data->name, name) == 0))
419 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
421 struct rte_cryptodev *dev = NULL;
423 if (dev_id >= rte_cryptodev_globals->nb_devs)
426 dev = rte_cryptodev_pmd_get_dev(dev_id);
427 if (dev->attached != RTE_CRYPTODEV_ATTACHED)
435 rte_cryptodev_get_dev_id(const char *name)
442 for (i = 0; i < rte_cryptodev_globals->nb_devs; i++)
443 if ((strcmp(rte_cryptodev_globals->devs[i].data->name, name)
445 (rte_cryptodev_globals->devs[i].attached ==
446 RTE_CRYPTODEV_ATTACHED))
453 rte_cryptodev_count(void)
455 return rte_cryptodev_globals->nb_devs;
459 rte_cryptodev_count_devtype(enum rte_cryptodev_type type)
461 uint8_t i, dev_count = 0;
463 for (i = 0; i < rte_cryptodev_globals->max_devs; i++)
464 if (rte_cryptodev_globals->devs[i].dev_type == type &&
465 rte_cryptodev_globals->devs[i].attached ==
466 RTE_CRYPTODEV_ATTACHED)
473 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices,
476 uint8_t i, count = 0;
477 struct rte_cryptodev *devs = rte_cryptodev_globals->devs;
478 uint8_t max_devs = rte_cryptodev_globals->max_devs;
480 for (i = 0; i < max_devs && count < nb_devices; i++) {
482 if (devs[i].attached == RTE_CRYPTODEV_ATTACHED) {
485 cmp = strncmp(devs[i].device->driver->name,
487 strlen(driver_name));
490 devices[count++] = devs[i].data->dev_id;
498 rte_cryptodev_socket_id(uint8_t dev_id)
500 struct rte_cryptodev *dev;
502 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
505 dev = rte_cryptodev_pmd_get_dev(dev_id);
507 return dev->data->socket_id;
511 rte_cryptodev_data_alloc(uint8_t dev_id, struct rte_cryptodev_data **data,
514 char mz_name[RTE_CRYPTODEV_NAME_MAX_LEN];
515 const struct rte_memzone *mz;
518 /* generate memzone name */
519 n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
520 if (n >= (int)sizeof(mz_name))
523 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
524 mz = rte_memzone_reserve(mz_name,
525 sizeof(struct rte_cryptodev_data),
528 mz = rte_memzone_lookup(mz_name);
534 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
535 memset(*data, 0, sizeof(struct rte_cryptodev_data));
541 rte_cryptodev_find_free_device_index(void)
545 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) {
546 if (rte_crypto_devices[dev_id].attached ==
547 RTE_CRYPTODEV_DETACHED)
550 return RTE_CRYPTO_MAX_DEVS;
553 struct rte_cryptodev *
554 rte_cryptodev_pmd_allocate(const char *name, int socket_id)
556 struct rte_cryptodev *cryptodev;
559 if (rte_cryptodev_pmd_get_named_dev(name) != NULL) {
560 CDEV_LOG_ERR("Crypto device with name %s already "
565 dev_id = rte_cryptodev_find_free_device_index();
566 if (dev_id == RTE_CRYPTO_MAX_DEVS) {
567 CDEV_LOG_ERR("Reached maximum number of crypto devices");
571 cryptodev = rte_cryptodev_pmd_get_dev(dev_id);
573 if (cryptodev->data == NULL) {
574 struct rte_cryptodev_data *cryptodev_data =
575 cryptodev_globals.data[dev_id];
577 int retval = rte_cryptodev_data_alloc(dev_id, &cryptodev_data,
580 if (retval < 0 || cryptodev_data == NULL)
583 cryptodev->data = cryptodev_data;
585 snprintf(cryptodev->data->name, RTE_CRYPTODEV_NAME_MAX_LEN,
588 cryptodev->data->dev_id = dev_id;
589 cryptodev->data->socket_id = socket_id;
590 cryptodev->data->dev_started = 0;
592 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
594 cryptodev_globals.nb_devs++;
601 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
605 if (cryptodev == NULL)
608 /* Close device only if device operations have been set */
609 if (cryptodev->dev_ops) {
610 ret = rte_cryptodev_close(cryptodev->data->dev_id);
615 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
616 cryptodev_globals.nb_devs--;
621 rte_cryptodev_queue_pair_count(uint8_t dev_id)
623 struct rte_cryptodev *dev;
625 dev = &rte_crypto_devices[dev_id];
626 return dev->data->nb_queue_pairs;
630 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
633 struct rte_cryptodev_info dev_info;
637 if ((dev == NULL) || (nb_qpairs < 1)) {
638 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
643 CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
644 nb_qpairs, dev->data->dev_id);
646 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
648 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
649 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
651 if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
652 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
653 nb_qpairs, dev->data->dev_id);
657 if (dev->data->queue_pairs == NULL) { /* first time configuration */
658 dev->data->queue_pairs = rte_zmalloc_socket(
659 "cryptodev->queue_pairs",
660 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
661 RTE_CACHE_LINE_SIZE, socket_id);
663 if (dev->data->queue_pairs == NULL) {
664 dev->data->nb_queue_pairs = 0;
665 CDEV_LOG_ERR("failed to get memory for qp meta data, "
670 } else { /* re-configure */
672 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
674 qp = dev->data->queue_pairs;
676 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
679 for (i = nb_qpairs; i < old_nb_queues; i++) {
680 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
685 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
686 RTE_CACHE_LINE_SIZE);
688 CDEV_LOG_ERR("failed to realloc qp meta data,"
689 " nb_queues %u", nb_qpairs);
693 if (nb_qpairs > old_nb_queues) {
694 uint16_t new_qs = nb_qpairs - old_nb_queues;
696 memset(qp + old_nb_queues, 0,
697 sizeof(qp[0]) * new_qs);
700 dev->data->queue_pairs = qp;
703 dev->data->nb_queue_pairs = nb_qpairs;
708 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id)
710 struct rte_cryptodev *dev;
712 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
713 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
717 dev = &rte_crypto_devices[dev_id];
718 if (queue_pair_id >= dev->data->nb_queue_pairs) {
719 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
723 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_start, -ENOTSUP);
725 return dev->dev_ops->queue_pair_start(dev, queue_pair_id);
730 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id)
732 struct rte_cryptodev *dev;
734 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
735 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
739 dev = &rte_crypto_devices[dev_id];
740 if (queue_pair_id >= dev->data->nb_queue_pairs) {
741 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
745 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_stop, -ENOTSUP);
747 return dev->dev_ops->queue_pair_stop(dev, queue_pair_id);
752 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
753 unsigned nb_objs, unsigned obj_cache_size, int socket_id);
756 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
758 struct rte_cryptodev *dev;
761 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
762 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
766 dev = &rte_crypto_devices[dev_id];
768 if (dev->data->dev_started) {
770 "device %d must be stopped to allow configuration", dev_id);
774 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
776 /* Setup new number of queue pairs and reconfigure device. */
777 diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
780 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
785 /* Setup Session mempool for device */
786 diag = rte_cryptodev_sym_session_pool_create(dev,
787 config->session_mp.nb_objs,
788 config->session_mp.cache_size,
793 return (*dev->dev_ops->dev_configure)(dev, config);
798 rte_cryptodev_start(uint8_t dev_id)
800 struct rte_cryptodev *dev;
803 CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
805 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
806 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
810 dev = &rte_crypto_devices[dev_id];
812 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
814 if (dev->data->dev_started != 0) {
815 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
820 diag = (*dev->dev_ops->dev_start)(dev);
822 dev->data->dev_started = 1;
830 rte_cryptodev_stop(uint8_t dev_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];
841 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
843 if (dev->data->dev_started == 0) {
844 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
849 (*dev->dev_ops->dev_stop)(dev);
850 dev->data->dev_started = 0;
854 rte_cryptodev_close(uint8_t dev_id)
856 struct rte_cryptodev *dev;
859 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
860 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
864 dev = &rte_crypto_devices[dev_id];
866 /* Device must be stopped before it can be closed */
867 if (dev->data->dev_started == 1) {
868 CDEV_LOG_ERR("Device %u must be stopped before closing",
873 /* We can't close the device if there are outstanding sessions in use */
874 if (dev->data->session_pool != NULL) {
875 if (!rte_mempool_full(dev->data->session_pool)) {
876 CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
877 "has sessions still in use, free "
878 "all sessions before calling close",
884 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
885 retval = (*dev->dev_ops->dev_close)(dev);
894 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
895 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id)
897 struct rte_cryptodev *dev;
899 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
900 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
904 dev = &rte_crypto_devices[dev_id];
905 if (queue_pair_id >= dev->data->nb_queue_pairs) {
906 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
910 if (dev->data->dev_started) {
912 "device %d must be stopped to allow configuration", dev_id);
916 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
918 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
924 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
926 struct rte_cryptodev *dev;
928 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
929 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
934 CDEV_LOG_ERR("Invalid stats ptr");
938 dev = &rte_crypto_devices[dev_id];
939 memset(stats, 0, sizeof(*stats));
941 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
942 (*dev->dev_ops->stats_get)(dev, stats);
947 rte_cryptodev_stats_reset(uint8_t dev_id)
949 struct rte_cryptodev *dev;
951 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
952 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
956 dev = &rte_crypto_devices[dev_id];
958 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
959 (*dev->dev_ops->stats_reset)(dev);
964 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
966 struct rte_cryptodev *dev;
968 if (dev_id >= cryptodev_globals.nb_devs) {
969 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
973 dev = &rte_crypto_devices[dev_id];
975 memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
977 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
978 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
980 dev_info->driver_name = dev->device->driver->name;
985 rte_cryptodev_callback_register(uint8_t dev_id,
986 enum rte_cryptodev_event_type event,
987 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
989 struct rte_cryptodev *dev;
990 struct rte_cryptodev_callback *user_cb;
995 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
996 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1000 dev = &rte_crypto_devices[dev_id];
1001 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1003 TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
1004 if (user_cb->cb_fn == cb_fn &&
1005 user_cb->cb_arg == cb_arg &&
1006 user_cb->event == event) {
1011 /* create a new callback. */
1012 if (user_cb == NULL) {
1013 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
1014 sizeof(struct rte_cryptodev_callback), 0);
1015 if (user_cb != NULL) {
1016 user_cb->cb_fn = cb_fn;
1017 user_cb->cb_arg = cb_arg;
1018 user_cb->event = event;
1019 TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
1023 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1024 return (user_cb == NULL) ? -ENOMEM : 0;
1028 rte_cryptodev_callback_unregister(uint8_t dev_id,
1029 enum rte_cryptodev_event_type event,
1030 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1033 struct rte_cryptodev *dev;
1034 struct rte_cryptodev_callback *cb, *next;
1039 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1040 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1044 dev = &rte_crypto_devices[dev_id];
1045 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1048 for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
1050 next = TAILQ_NEXT(cb, next);
1052 if (cb->cb_fn != cb_fn || cb->event != event ||
1053 (cb->cb_arg != (void *)-1 &&
1054 cb->cb_arg != cb_arg))
1058 * if this callback is not executing right now,
1061 if (cb->active == 0) {
1062 TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
1069 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1074 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
1075 enum rte_cryptodev_event_type event)
1077 struct rte_cryptodev_callback *cb_lst;
1078 struct rte_cryptodev_callback dev_cb;
1080 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1081 TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
1082 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
1086 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1087 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
1089 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1092 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1097 rte_cryptodev_sym_session_init(struct rte_mempool *mp,
1100 __rte_unused unsigned i)
1102 struct rte_cryptodev_sym_session *sess = _sess;
1103 struct rte_cryptodev *dev = opaque_arg;
1105 memset(sess, 0, mp->elt_size);
1107 sess->dev_id = dev->data->dev_id;
1108 sess->dev_type = dev->dev_type;
1111 if (dev->dev_ops->session_initialize)
1112 (*dev->dev_ops->session_initialize)(mp, sess);
1116 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
1117 unsigned nb_objs, unsigned obj_cache_size, int socket_id)
1119 char mp_name[RTE_CRYPTODEV_NAME_MAX_LEN];
1120 unsigned priv_sess_size;
1122 unsigned n = snprintf(mp_name, sizeof(mp_name), "cdev_%d_sess_mp",
1124 if (n > sizeof(mp_name)) {
1125 CDEV_LOG_ERR("Unable to create unique name for session mempool");
1129 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_get_size, -ENOTSUP);
1130 priv_sess_size = (*dev->dev_ops->session_get_size)(dev);
1131 if (priv_sess_size == 0) {
1132 CDEV_LOG_ERR("%s returned and invalid private session size ",
1137 unsigned elt_size = sizeof(struct rte_cryptodev_sym_session) +
1140 dev->data->session_pool = rte_mempool_lookup(mp_name);
1141 if (dev->data->session_pool != NULL) {
1142 if ((dev->data->session_pool->elt_size != elt_size) ||
1143 (dev->data->session_pool->cache_size <
1145 (dev->data->session_pool->size < nb_objs)) {
1147 CDEV_LOG_ERR("%s mempool already exists with different"
1148 " initialization parameters", mp_name);
1149 dev->data->session_pool = NULL;
1153 dev->data->session_pool = rte_mempool_create(
1154 mp_name, /* mempool name */
1155 nb_objs, /* number of elements*/
1156 elt_size, /* element size*/
1157 obj_cache_size, /* Cache size*/
1158 0, /* private data size */
1159 NULL, /* obj initialization constructor */
1160 NULL, /* obj initialization constructor arg */
1161 rte_cryptodev_sym_session_init,
1162 /**< obj constructor*/
1163 dev, /* obj constructor arg */
1164 socket_id, /* socket id */
1167 if (dev->data->session_pool == NULL) {
1168 CDEV_LOG_ERR("%s mempool allocation failed", mp_name);
1173 CDEV_LOG_DEBUG("%s mempool created!", mp_name);
1177 struct rte_cryptodev_sym_session *
1178 rte_cryptodev_sym_session_create(uint8_t dev_id,
1179 struct rte_crypto_sym_xform *xform)
1181 struct rte_cryptodev *dev;
1182 struct rte_cryptodev_sym_session *sess;
1185 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1186 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1190 dev = &rte_crypto_devices[dev_id];
1192 /* Allocate a session structure from the session pool */
1193 if (rte_mempool_get(dev->data->session_pool, &_sess)) {
1194 CDEV_LOG_ERR("Couldn't get object from session mempool");
1200 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_configure, NULL);
1201 if (dev->dev_ops->session_configure(dev, xform, sess->_private) ==
1203 CDEV_LOG_ERR("dev_id %d failed to configure session details",
1206 /* Return session to mempool */
1207 rte_mempool_put(sess->mp, _sess);
1215 rte_cryptodev_queue_pair_attach_sym_session(uint16_t qp_id,
1216 struct rte_cryptodev_sym_session *sess)
1218 struct rte_cryptodev *dev;
1220 if (!rte_cryptodev_pmd_is_valid_dev(sess->dev_id)) {
1221 CDEV_LOG_ERR("Invalid dev_id=%d", sess->dev_id);
1225 dev = &rte_crypto_devices[sess->dev_id];
1227 /* The API is optional, not returning error if driver do not suuport */
1228 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_attach_session, 0);
1229 if (dev->dev_ops->qp_attach_session(dev, qp_id, sess->_private)) {
1230 CDEV_LOG_ERR("dev_id %d failed to attach qp: %d with session",
1231 sess->dev_id, qp_id);
1239 rte_cryptodev_queue_pair_detach_sym_session(uint16_t qp_id,
1240 struct rte_cryptodev_sym_session *sess)
1242 struct rte_cryptodev *dev;
1244 if (!rte_cryptodev_pmd_is_valid_dev(sess->dev_id)) {
1245 CDEV_LOG_ERR("Invalid dev_id=%d", sess->dev_id);
1249 dev = &rte_crypto_devices[sess->dev_id];
1251 /* The API is optional, not returning error if driver do not suuport */
1252 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->qp_detach_session, 0);
1253 if (dev->dev_ops->qp_detach_session(dev, qp_id, sess->_private)) {
1254 CDEV_LOG_ERR("dev_id %d failed to detach qp: %d from session",
1255 sess->dev_id, qp_id);
1261 struct rte_cryptodev_sym_session *
1262 rte_cryptodev_sym_session_free(uint8_t dev_id,
1263 struct rte_cryptodev_sym_session *sess)
1265 struct rte_cryptodev *dev;
1267 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1268 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1272 dev = &rte_crypto_devices[dev_id];
1274 /* Check the session belongs to this device type */
1275 if (sess->dev_type != dev->dev_type)
1278 /* Let device implementation clear session material */
1279 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_clear, sess);
1280 dev->dev_ops->session_clear(dev, (void *)sess->_private);
1282 /* Return session to mempool */
1283 rte_mempool_put(sess->mp, (void *)sess);
1288 /** Initialise rte_crypto_op mempool element */
1290 rte_crypto_op_init(struct rte_mempool *mempool,
1293 __rte_unused unsigned i)
1295 struct rte_crypto_op *op = _op_data;
1296 enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
1298 memset(_op_data, 0, mempool->elt_size);
1300 __rte_crypto_op_reset(op, type);
1302 op->phys_addr = rte_mem_virt2phy(_op_data);
1303 op->mempool = mempool;
1307 struct rte_mempool *
1308 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
1309 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
1312 struct rte_crypto_op_pool_private *priv;
1314 unsigned elt_size = sizeof(struct rte_crypto_op) +
1315 sizeof(struct rte_crypto_sym_op) +
1318 /* lookup mempool in case already allocated */
1319 struct rte_mempool *mp = rte_mempool_lookup(name);
1322 priv = (struct rte_crypto_op_pool_private *)
1323 rte_mempool_get_priv(mp);
1325 if (mp->elt_size != elt_size ||
1326 mp->cache_size < cache_size ||
1327 mp->size < nb_elts ||
1328 priv->priv_size < priv_size) {
1330 CDEV_LOG_ERR("Mempool %s already exists but with "
1331 "incompatible parameters", name);
1337 mp = rte_mempool_create(
1342 sizeof(struct rte_crypto_op_pool_private),
1351 CDEV_LOG_ERR("Failed to create mempool %s", name);
1355 priv = (struct rte_crypto_op_pool_private *)
1356 rte_mempool_get_priv(mp);
1358 priv->priv_size = priv_size;
1365 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix)
1367 struct rte_cryptodev *dev = NULL;
1373 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
1374 int ret = snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
1375 "%s_%u", dev_name_prefix, i);
1380 dev = rte_cryptodev_pmd_get_named_dev(name);