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>
51 #include <rte_memory.h>
52 #include <rte_memcpy.h>
53 #include <rte_memzone.h>
54 #include <rte_launch.h>
55 #include <rte_tailq.h>
57 #include <rte_per_lcore.h>
58 #include <rte_lcore.h>
59 #include <rte_atomic.h>
60 #include <rte_branch_prediction.h>
61 #include <rte_common.h>
62 #include <rte_mempool.h>
63 #include <rte_malloc.h>
65 #include <rte_errno.h>
66 #include <rte_spinlock.h>
67 #include <rte_string_fns.h>
69 #include "rte_crypto.h"
70 #include "rte_cryptodev.h"
71 #include "rte_cryptodev_pmd.h"
73 struct rte_cryptodev rte_crypto_devices[RTE_CRYPTO_MAX_DEVS];
75 struct rte_cryptodev *rte_cryptodevs = &rte_crypto_devices[0];
77 static struct rte_cryptodev_global cryptodev_globals = {
78 .devs = &rte_crypto_devices[0],
81 .max_devs = RTE_CRYPTO_MAX_DEVS
84 struct rte_cryptodev_global *rte_cryptodev_globals = &cryptodev_globals;
86 /* spinlock for crypto device callbacks */
87 static rte_spinlock_t rte_cryptodev_cb_lock = RTE_SPINLOCK_INITIALIZER;
91 * The user application callback description.
93 * It contains callback address to be registered by user application,
94 * the pointer to the parameters for callback, and the event type.
96 struct rte_cryptodev_callback {
97 TAILQ_ENTRY(rte_cryptodev_callback) next; /**< Callbacks list */
98 rte_cryptodev_cb_fn cb_fn; /**< Callback address */
99 void *cb_arg; /**< Parameter for callback */
100 enum rte_cryptodev_event_type event; /**< Interrupt event type */
101 uint32_t active; /**< Callback is executing */
104 #define RTE_CRYPTODEV_VDEV_NAME ("name")
105 #define RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG ("max_nb_queue_pairs")
106 #define RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG ("max_nb_sessions")
107 #define RTE_CRYPTODEV_VDEV_SOCKET_ID ("socket_id")
109 static const char *cryptodev_vdev_valid_params[] = {
110 RTE_CRYPTODEV_VDEV_NAME,
111 RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
112 RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
113 RTE_CRYPTODEV_VDEV_SOCKET_ID
117 * The crypto cipher algorithm strings identifiers.
118 * It could be used in application command line.
121 rte_crypto_cipher_algorithm_strings[] = {
122 [RTE_CRYPTO_CIPHER_3DES_CBC] = "3des-cbc",
123 [RTE_CRYPTO_CIPHER_3DES_ECB] = "3des-ecb",
124 [RTE_CRYPTO_CIPHER_3DES_CTR] = "3des-ctr",
126 [RTE_CRYPTO_CIPHER_AES_CBC] = "aes-cbc",
127 [RTE_CRYPTO_CIPHER_AES_CCM] = "aes-ccm",
128 [RTE_CRYPTO_CIPHER_AES_CTR] = "aes-ctr",
129 [RTE_CRYPTO_CIPHER_AES_ECB] = "aes-ecb",
130 [RTE_CRYPTO_CIPHER_AES_GCM] = "aes-gcm",
131 [RTE_CRYPTO_CIPHER_AES_F8] = "aes-f8",
132 [RTE_CRYPTO_CIPHER_AES_XTS] = "aes-xts",
134 [RTE_CRYPTO_CIPHER_ARC4] = "arc4",
136 [RTE_CRYPTO_CIPHER_DES_CBC] = "des-cbc",
138 [RTE_CRYPTO_CIPHER_NULL] = "null",
140 [RTE_CRYPTO_CIPHER_KASUMI_F8] = "kasumi-f8",
141 [RTE_CRYPTO_CIPHER_SNOW3G_UEA2] = "snow3g-uea2",
142 [RTE_CRYPTO_CIPHER_ZUC_EEA3] = "zuc-eea3"
146 * The crypto cipher operation strings identifiers.
147 * It could be used in application command line.
150 rte_crypto_cipher_operation_strings[] = {
151 [RTE_CRYPTO_CIPHER_OP_ENCRYPT] = "encrypt",
152 [RTE_CRYPTO_CIPHER_OP_DECRYPT] = "decrypt"
156 * The crypto auth algorithm strings identifiers.
157 * It could be used in application command line.
160 rte_crypto_auth_algorithm_strings[] = {
161 [RTE_CRYPTO_AUTH_AES_CBC_MAC] = "aes-cbc-mac",
162 [RTE_CRYPTO_AUTH_AES_CCM] = "aes-ccm",
163 [RTE_CRYPTO_AUTH_AES_CMAC] = "aes-cmac",
164 [RTE_CRYPTO_AUTH_AES_GCM] = "aes-gcm",
165 [RTE_CRYPTO_AUTH_AES_GMAC] = "aes-gmac",
166 [RTE_CRYPTO_AUTH_AES_XCBC_MAC] = "aes-xcbc-mac",
168 [RTE_CRYPTO_AUTH_MD5] = "md5",
169 [RTE_CRYPTO_AUTH_MD5_HMAC] = "md5-hmac",
171 [RTE_CRYPTO_AUTH_NULL] = "null",
173 [RTE_CRYPTO_AUTH_SHA1] = "sha1",
174 [RTE_CRYPTO_AUTH_SHA1_HMAC] = "sha1-hmac",
176 [RTE_CRYPTO_AUTH_SHA224] = "sha2-224",
177 [RTE_CRYPTO_AUTH_SHA224_HMAC] = "sha2-224-hmac",
178 [RTE_CRYPTO_AUTH_SHA256] = "sha2-256",
179 [RTE_CRYPTO_AUTH_SHA256_HMAC] = "sha2-256-hmac",
180 [RTE_CRYPTO_AUTH_SHA384] = "sha2-384",
181 [RTE_CRYPTO_AUTH_SHA384_HMAC] = "sha2-384-hmac",
182 [RTE_CRYPTO_AUTH_SHA512] = "sha2-512",
183 [RTE_CRYPTO_AUTH_SHA512_HMAC] = "sha2-512-hmac",
185 [RTE_CRYPTO_AUTH_KASUMI_F9] = "kasumi-f9",
186 [RTE_CRYPTO_AUTH_SNOW3G_UIA2] = "snow3g-uia2",
187 [RTE_CRYPTO_AUTH_ZUC_EIA3] = "zuc-eia3"
191 rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum,
192 const char *algo_string)
196 for (i = 1; i < RTE_DIM(rte_crypto_cipher_algorithm_strings); i++) {
197 if (strcmp(algo_string, rte_crypto_cipher_algorithm_strings[i]) == 0) {
198 *algo_enum = (enum rte_crypto_cipher_algorithm) i;
208 rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum,
209 const char *algo_string)
213 for (i = 1; i < RTE_DIM(rte_crypto_auth_algorithm_strings); i++) {
214 if (strcmp(algo_string, rte_crypto_auth_algorithm_strings[i]) == 0) {
215 *algo_enum = (enum rte_crypto_auth_algorithm) i;
225 * The crypto auth operation strings identifiers.
226 * It could be used in application command line.
229 rte_crypto_auth_operation_strings[] = {
230 [RTE_CRYPTO_AUTH_OP_VERIFY] = "verify",
231 [RTE_CRYPTO_AUTH_OP_GENERATE] = "generate"
235 number_of_sockets(void)
239 const struct rte_memseg *ms = rte_eal_get_physmem_layout();
241 for (i = 0; ((i < RTE_MAX_MEMSEG) && (ms[i].addr != NULL)); i++) {
242 if (sockets < ms[i].socket_id)
243 sockets = ms[i].socket_id;
246 /* Number of sockets = maximum socket_id + 1 */
250 /** Parse integer from integer argument */
252 parse_integer_arg(const char *key __rte_unused,
253 const char *value, void *extra_args)
255 int *i = (int *) extra_args;
259 CDEV_LOG_ERR("Argument has to be positive.");
268 parse_name_arg(const char *key __rte_unused,
269 const char *value, void *extra_args)
271 struct rte_crypto_vdev_init_params *params = extra_args;
273 if (strlen(value) >= RTE_CRYPTODEV_NAME_MAX_LEN - 1) {
274 CDEV_LOG_ERR("Invalid name %s, should be less than "
276 RTE_CRYPTODEV_NAME_MAX_LEN - 1);
280 strncpy(params->name, value, RTE_CRYPTODEV_NAME_MAX_LEN);
286 rte_cryptodev_parse_vdev_init_params(struct rte_crypto_vdev_init_params *params,
287 const char *input_args)
289 struct rte_kvargs *kvlist = NULL;
296 kvlist = rte_kvargs_parse(input_args,
297 cryptodev_vdev_valid_params);
301 ret = rte_kvargs_process(kvlist,
302 RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
304 ¶ms->max_nb_queue_pairs);
308 ret = rte_kvargs_process(kvlist,
309 RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
311 ¶ms->max_nb_sessions);
315 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SOCKET_ID,
321 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_NAME,
327 if (params->socket_id >= number_of_sockets()) {
328 CDEV_LOG_ERR("Invalid socket id specified to create "
329 "the virtual crypto device on");
335 rte_kvargs_free(kvlist);
339 const struct rte_cryptodev_symmetric_capability *
340 rte_cryptodev_sym_capability_get(uint8_t dev_id,
341 const struct rte_cryptodev_sym_capability_idx *idx)
343 const struct rte_cryptodev_capabilities *capability;
344 struct rte_cryptodev_info dev_info;
347 rte_cryptodev_info_get(dev_id, &dev_info);
349 while ((capability = &dev_info.capabilities[i++])->op !=
350 RTE_CRYPTO_OP_TYPE_UNDEFINED) {
351 if (capability->op != RTE_CRYPTO_OP_TYPE_SYMMETRIC)
354 if (capability->sym.xform_type != idx->type)
357 if (idx->type == RTE_CRYPTO_SYM_XFORM_AUTH &&
358 capability->sym.auth.algo == idx->algo.auth)
359 return &capability->sym;
361 if (idx->type == RTE_CRYPTO_SYM_XFORM_CIPHER &&
362 capability->sym.cipher.algo == idx->algo.cipher)
363 return &capability->sym;
370 #define param_range_check(x, y) \
371 (((x < y.min) || (x > y.max)) || \
372 (y.increment != 0 && (x % y.increment) != 0))
375 rte_cryptodev_sym_capability_check_cipher(
376 const struct rte_cryptodev_symmetric_capability *capability,
377 uint16_t key_size, uint16_t iv_size)
379 if (param_range_check(key_size, capability->cipher.key_size))
382 if (param_range_check(iv_size, capability->cipher.iv_size))
389 rte_cryptodev_sym_capability_check_auth(
390 const struct rte_cryptodev_symmetric_capability *capability,
391 uint16_t key_size, uint16_t digest_size, uint16_t aad_size)
393 if (param_range_check(key_size, capability->auth.key_size))
396 if (param_range_check(digest_size, capability->auth.digest_size))
399 if (param_range_check(aad_size, capability->auth.aad_size))
407 rte_cryptodev_get_feature_name(uint64_t flag)
410 case RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO:
411 return "SYMMETRIC_CRYPTO";
412 case RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO:
413 return "ASYMMETRIC_CRYPTO";
414 case RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING:
415 return "SYM_OPERATION_CHAINING";
416 case RTE_CRYPTODEV_FF_CPU_SSE:
418 case RTE_CRYPTODEV_FF_CPU_AVX:
420 case RTE_CRYPTODEV_FF_CPU_AVX2:
422 case RTE_CRYPTODEV_FF_CPU_AESNI:
424 case RTE_CRYPTODEV_FF_HW_ACCELERATED:
425 return "HW_ACCELERATED";
426 case RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER:
427 return "MBUF_SCATTER_GATHER";
428 case RTE_CRYPTODEV_FF_CPU_NEON:
430 case RTE_CRYPTODEV_FF_CPU_ARM_CE:
438 rte_cryptodev_create_vdev(const char *name, const char *args)
440 return rte_eal_vdev_init(name, args);
443 struct rte_cryptodev *
444 rte_cryptodev_pmd_get_dev(uint8_t dev_id)
446 return &rte_cryptodev_globals->devs[dev_id];
449 struct rte_cryptodev *
450 rte_cryptodev_pmd_get_named_dev(const char *name)
452 struct rte_cryptodev *dev;
458 for (i = 0; i < rte_cryptodev_globals->max_devs; i++) {
459 dev = &rte_cryptodev_globals->devs[i];
461 if ((dev->attached == RTE_CRYPTODEV_ATTACHED) &&
462 (strcmp(dev->data->name, name) == 0))
470 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
472 struct rte_cryptodev *dev = NULL;
474 if (dev_id >= rte_cryptodev_globals->nb_devs)
477 dev = rte_cryptodev_pmd_get_dev(dev_id);
478 if (dev->attached != RTE_CRYPTODEV_ATTACHED)
486 rte_cryptodev_get_dev_id(const char *name)
493 for (i = 0; i < rte_cryptodev_globals->nb_devs; i++)
494 if ((strcmp(rte_cryptodev_globals->devs[i].data->name, name)
496 (rte_cryptodev_globals->devs[i].attached ==
497 RTE_CRYPTODEV_ATTACHED))
504 rte_cryptodev_count(void)
506 return rte_cryptodev_globals->nb_devs;
510 rte_cryptodev_count_devtype(enum rte_cryptodev_type type)
512 uint8_t i, dev_count = 0;
514 for (i = 0; i < rte_cryptodev_globals->max_devs; i++)
515 if (rte_cryptodev_globals->devs[i].dev_type == type &&
516 rte_cryptodev_globals->devs[i].attached ==
517 RTE_CRYPTODEV_ATTACHED)
524 rte_cryptodev_devices_get(const char *dev_name, uint8_t *devices,
527 uint8_t i, count = 0;
528 struct rte_cryptodev *devs = rte_cryptodev_globals->devs;
529 uint8_t max_devs = rte_cryptodev_globals->max_devs;
531 for (i = 0; i < max_devs && count < nb_devices; i++) {
533 if (devs[i].attached == RTE_CRYPTODEV_ATTACHED) {
534 const struct rte_cryptodev_driver *drv = devs[i].driver;
538 cmp = strncmp(drv->pci_drv.driver.name,
539 dev_name, strlen(dev_name));
541 cmp = strncmp(devs[i].data->name,
542 dev_name, strlen(dev_name));
545 devices[count++] = devs[i].data->dev_id;
553 rte_cryptodev_socket_id(uint8_t dev_id)
555 struct rte_cryptodev *dev;
557 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
560 dev = rte_cryptodev_pmd_get_dev(dev_id);
562 return dev->data->socket_id;
566 rte_cryptodev_data_alloc(uint8_t dev_id, struct rte_cryptodev_data **data,
569 char mz_name[RTE_CRYPTODEV_NAME_MAX_LEN];
570 const struct rte_memzone *mz;
573 /* generate memzone name */
574 n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
575 if (n >= (int)sizeof(mz_name))
578 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
579 mz = rte_memzone_reserve(mz_name,
580 sizeof(struct rte_cryptodev_data),
583 mz = rte_memzone_lookup(mz_name);
589 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
590 memset(*data, 0, sizeof(struct rte_cryptodev_data));
596 rte_cryptodev_find_free_device_index(void)
600 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) {
601 if (rte_crypto_devices[dev_id].attached ==
602 RTE_CRYPTODEV_DETACHED)
605 return RTE_CRYPTO_MAX_DEVS;
608 struct rte_cryptodev *
609 rte_cryptodev_pmd_allocate(const char *name, int socket_id)
611 struct rte_cryptodev *cryptodev;
614 if (rte_cryptodev_pmd_get_named_dev(name) != NULL) {
615 CDEV_LOG_ERR("Crypto device with name %s already "
620 dev_id = rte_cryptodev_find_free_device_index();
621 if (dev_id == RTE_CRYPTO_MAX_DEVS) {
622 CDEV_LOG_ERR("Reached maximum number of crypto devices");
626 cryptodev = rte_cryptodev_pmd_get_dev(dev_id);
628 if (cryptodev->data == NULL) {
629 struct rte_cryptodev_data *cryptodev_data =
630 cryptodev_globals.data[dev_id];
632 int retval = rte_cryptodev_data_alloc(dev_id, &cryptodev_data,
635 if (retval < 0 || cryptodev_data == NULL)
638 cryptodev->data = cryptodev_data;
640 snprintf(cryptodev->data->name, RTE_CRYPTODEV_NAME_MAX_LEN,
643 cryptodev->data->dev_id = dev_id;
644 cryptodev->data->socket_id = socket_id;
645 cryptodev->data->dev_started = 0;
647 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
649 cryptodev_globals.nb_devs++;
656 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
660 if (cryptodev == NULL)
663 ret = rte_cryptodev_close(cryptodev->data->dev_id);
667 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
668 cryptodev_globals.nb_devs--;
672 struct rte_cryptodev *
673 rte_cryptodev_pmd_virtual_dev_init(const char *name, size_t dev_private_size,
676 struct rte_cryptodev *cryptodev;
678 /* allocate device structure */
679 cryptodev = rte_cryptodev_pmd_allocate(name, socket_id);
680 if (cryptodev == NULL)
683 /* allocate private device structure */
684 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
685 cryptodev->data->dev_private =
686 rte_zmalloc_socket("cryptodev device private",
691 if (cryptodev->data->dev_private == NULL)
692 rte_panic("Cannot allocate memzone for private device"
696 /* initialise user call-back tail queue */
697 TAILQ_INIT(&(cryptodev->link_intr_cbs));
703 rte_cryptodev_pci_probe(struct rte_pci_driver *pci_drv,
704 struct rte_pci_device *pci_dev)
706 struct rte_cryptodev_driver *cryptodrv;
707 struct rte_cryptodev *cryptodev;
709 char cryptodev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
713 cryptodrv = (struct rte_cryptodev_driver *)pci_drv;
714 if (cryptodrv == NULL)
717 rte_eal_pci_device_name(&pci_dev->addr, cryptodev_name,
718 sizeof(cryptodev_name));
720 cryptodev = rte_cryptodev_pmd_allocate(cryptodev_name, rte_socket_id());
721 if (cryptodev == NULL)
724 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
725 cryptodev->data->dev_private =
727 "cryptodev private structure",
728 cryptodrv->dev_private_size,
732 if (cryptodev->data->dev_private == NULL)
733 rte_panic("Cannot allocate memzone for private "
737 cryptodev->device = &pci_dev->device;
738 cryptodev->driver = cryptodrv;
740 /* init user callbacks */
741 TAILQ_INIT(&(cryptodev->link_intr_cbs));
743 /* Invoke PMD device initialization function */
744 retval = (*cryptodrv->cryptodev_init)(cryptodrv, cryptodev);
748 CDEV_LOG_ERR("driver %s: crypto_dev_init(vendor_id=0x%x device_id=0x%x)"
749 " failed", pci_drv->driver.name,
750 (unsigned) pci_dev->id.vendor_id,
751 (unsigned) pci_dev->id.device_id);
753 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
754 rte_free(cryptodev->data->dev_private);
756 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
757 cryptodev_globals.nb_devs--;
763 rte_cryptodev_pci_remove(struct rte_pci_device *pci_dev)
765 const struct rte_cryptodev_driver *cryptodrv;
766 struct rte_cryptodev *cryptodev;
767 char cryptodev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
773 rte_eal_pci_device_name(&pci_dev->addr, cryptodev_name,
774 sizeof(cryptodev_name));
776 cryptodev = rte_cryptodev_pmd_get_named_dev(cryptodev_name);
777 if (cryptodev == NULL)
780 cryptodrv = (const struct rte_cryptodev_driver *)pci_dev->driver;
781 if (cryptodrv == NULL)
784 /* Invoke PMD device uninit function */
785 if (*cryptodrv->cryptodev_uninit) {
786 ret = (*cryptodrv->cryptodev_uninit)(cryptodrv, cryptodev);
791 /* free crypto device */
792 rte_cryptodev_pmd_release_device(cryptodev);
794 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
795 rte_free(cryptodev->data->dev_private);
797 cryptodev->device = NULL;
798 cryptodev->driver = NULL;
799 cryptodev->data = NULL;
805 rte_cryptodev_queue_pair_count(uint8_t dev_id)
807 struct rte_cryptodev *dev;
809 dev = &rte_crypto_devices[dev_id];
810 return dev->data->nb_queue_pairs;
814 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
817 struct rte_cryptodev_info dev_info;
821 if ((dev == NULL) || (nb_qpairs < 1)) {
822 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
827 CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
828 nb_qpairs, dev->data->dev_id);
830 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
832 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
833 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
835 if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
836 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
837 nb_qpairs, dev->data->dev_id);
841 if (dev->data->queue_pairs == NULL) { /* first time configuration */
842 dev->data->queue_pairs = rte_zmalloc_socket(
843 "cryptodev->queue_pairs",
844 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
845 RTE_CACHE_LINE_SIZE, socket_id);
847 if (dev->data->queue_pairs == NULL) {
848 dev->data->nb_queue_pairs = 0;
849 CDEV_LOG_ERR("failed to get memory for qp meta data, "
854 } else { /* re-configure */
856 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
858 qp = dev->data->queue_pairs;
860 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
863 for (i = nb_qpairs; i < old_nb_queues; i++) {
864 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
869 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
870 RTE_CACHE_LINE_SIZE);
872 CDEV_LOG_ERR("failed to realloc qp meta data,"
873 " nb_queues %u", nb_qpairs);
877 if (nb_qpairs > old_nb_queues) {
878 uint16_t new_qs = nb_qpairs - old_nb_queues;
880 memset(qp + old_nb_queues, 0,
881 sizeof(qp[0]) * new_qs);
884 dev->data->queue_pairs = qp;
887 dev->data->nb_queue_pairs = nb_qpairs;
892 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id)
894 struct rte_cryptodev *dev;
896 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
897 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
901 dev = &rte_crypto_devices[dev_id];
902 if (queue_pair_id >= dev->data->nb_queue_pairs) {
903 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
907 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_start, -ENOTSUP);
909 return dev->dev_ops->queue_pair_start(dev, queue_pair_id);
914 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id)
916 struct rte_cryptodev *dev;
918 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
919 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
923 dev = &rte_crypto_devices[dev_id];
924 if (queue_pair_id >= dev->data->nb_queue_pairs) {
925 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
929 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_stop, -ENOTSUP);
931 return dev->dev_ops->queue_pair_stop(dev, queue_pair_id);
936 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
937 unsigned nb_objs, unsigned obj_cache_size, int socket_id);
940 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
942 struct rte_cryptodev *dev;
945 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
946 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
950 dev = &rte_crypto_devices[dev_id];
952 if (dev->data->dev_started) {
954 "device %d must be stopped to allow configuration", dev_id);
958 /* Setup new number of queue pairs and reconfigure device. */
959 diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
962 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
967 /* Setup Session mempool for device */
968 return rte_cryptodev_sym_session_pool_create(dev,
969 config->session_mp.nb_objs,
970 config->session_mp.cache_size,
976 rte_cryptodev_start(uint8_t dev_id)
978 struct rte_cryptodev *dev;
981 CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
983 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
984 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
988 dev = &rte_crypto_devices[dev_id];
990 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
992 if (dev->data->dev_started != 0) {
993 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
998 diag = (*dev->dev_ops->dev_start)(dev);
1000 dev->data->dev_started = 1;
1008 rte_cryptodev_stop(uint8_t dev_id)
1010 struct rte_cryptodev *dev;
1012 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1013 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1017 dev = &rte_crypto_devices[dev_id];
1019 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
1021 if (dev->data->dev_started == 0) {
1022 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
1027 dev->data->dev_started = 0;
1028 (*dev->dev_ops->dev_stop)(dev);
1032 rte_cryptodev_close(uint8_t dev_id)
1034 struct rte_cryptodev *dev;
1037 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1038 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1042 dev = &rte_crypto_devices[dev_id];
1044 /* Device must be stopped before it can be closed */
1045 if (dev->data->dev_started == 1) {
1046 CDEV_LOG_ERR("Device %u must be stopped before closing",
1051 /* We can't close the device if there are outstanding sessions in use */
1052 if (dev->data->session_pool != NULL) {
1053 if (!rte_mempool_full(dev->data->session_pool)) {
1054 CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
1055 "has sessions still in use, free "
1056 "all sessions before calling close",
1062 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
1063 retval = (*dev->dev_ops->dev_close)(dev);
1072 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
1073 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id)
1075 struct rte_cryptodev *dev;
1077 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1078 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1082 dev = &rte_crypto_devices[dev_id];
1083 if (queue_pair_id >= dev->data->nb_queue_pairs) {
1084 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
1088 if (dev->data->dev_started) {
1090 "device %d must be stopped to allow configuration", dev_id);
1094 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
1096 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
1102 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
1104 struct rte_cryptodev *dev;
1106 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1107 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1111 if (stats == NULL) {
1112 CDEV_LOG_ERR("Invalid stats ptr");
1116 dev = &rte_crypto_devices[dev_id];
1117 memset(stats, 0, sizeof(*stats));
1119 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
1120 (*dev->dev_ops->stats_get)(dev, stats);
1125 rte_cryptodev_stats_reset(uint8_t dev_id)
1127 struct rte_cryptodev *dev;
1129 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1130 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1134 dev = &rte_crypto_devices[dev_id];
1136 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
1137 (*dev->dev_ops->stats_reset)(dev);
1142 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
1144 struct rte_cryptodev *dev;
1146 if (dev_id >= cryptodev_globals.nb_devs) {
1147 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1151 dev = &rte_crypto_devices[dev_id];
1153 memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
1155 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
1156 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
1158 dev_info->pci_dev = RTE_DEV_TO_PCI(dev->device);
1160 dev_info->driver_name = dev->driver->pci_drv.driver.name;
1165 rte_cryptodev_callback_register(uint8_t dev_id,
1166 enum rte_cryptodev_event_type event,
1167 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1169 struct rte_cryptodev *dev;
1170 struct rte_cryptodev_callback *user_cb;
1175 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1176 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1180 dev = &rte_crypto_devices[dev_id];
1181 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1183 TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
1184 if (user_cb->cb_fn == cb_fn &&
1185 user_cb->cb_arg == cb_arg &&
1186 user_cb->event == event) {
1191 /* create a new callback. */
1192 if (user_cb == NULL) {
1193 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
1194 sizeof(struct rte_cryptodev_callback), 0);
1195 if (user_cb != NULL) {
1196 user_cb->cb_fn = cb_fn;
1197 user_cb->cb_arg = cb_arg;
1198 user_cb->event = event;
1199 TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
1203 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1204 return (user_cb == NULL) ? -ENOMEM : 0;
1208 rte_cryptodev_callback_unregister(uint8_t dev_id,
1209 enum rte_cryptodev_event_type event,
1210 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1213 struct rte_cryptodev *dev;
1214 struct rte_cryptodev_callback *cb, *next;
1219 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1220 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1224 dev = &rte_crypto_devices[dev_id];
1225 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1228 for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
1230 next = TAILQ_NEXT(cb, next);
1232 if (cb->cb_fn != cb_fn || cb->event != event ||
1233 (cb->cb_arg != (void *)-1 &&
1234 cb->cb_arg != cb_arg))
1238 * if this callback is not executing right now,
1241 if (cb->active == 0) {
1242 TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
1249 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1254 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
1255 enum rte_cryptodev_event_type event)
1257 struct rte_cryptodev_callback *cb_lst;
1258 struct rte_cryptodev_callback dev_cb;
1260 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1261 TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
1262 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
1266 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1267 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
1269 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1272 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1277 rte_cryptodev_sym_session_init(struct rte_mempool *mp,
1280 __rte_unused unsigned i)
1282 struct rte_cryptodev_sym_session *sess = _sess;
1283 struct rte_cryptodev *dev = opaque_arg;
1285 memset(sess, 0, mp->elt_size);
1287 sess->dev_id = dev->data->dev_id;
1288 sess->dev_type = dev->dev_type;
1291 if (dev->dev_ops->session_initialize)
1292 (*dev->dev_ops->session_initialize)(mp, sess);
1296 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
1297 unsigned nb_objs, unsigned obj_cache_size, int socket_id)
1299 char mp_name[RTE_CRYPTODEV_NAME_MAX_LEN];
1300 unsigned priv_sess_size;
1302 unsigned n = snprintf(mp_name, sizeof(mp_name), "cdev_%d_sess_mp",
1304 if (n > sizeof(mp_name)) {
1305 CDEV_LOG_ERR("Unable to create unique name for session mempool");
1309 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_get_size, -ENOTSUP);
1310 priv_sess_size = (*dev->dev_ops->session_get_size)(dev);
1311 if (priv_sess_size == 0) {
1312 CDEV_LOG_ERR("%s returned and invalid private session size ",
1317 unsigned elt_size = sizeof(struct rte_cryptodev_sym_session) +
1320 dev->data->session_pool = rte_mempool_lookup(mp_name);
1321 if (dev->data->session_pool != NULL) {
1322 if ((dev->data->session_pool->elt_size != elt_size) ||
1323 (dev->data->session_pool->cache_size <
1325 (dev->data->session_pool->size < nb_objs)) {
1327 CDEV_LOG_ERR("%s mempool already exists with different"
1328 " initialization parameters", mp_name);
1329 dev->data->session_pool = NULL;
1333 dev->data->session_pool = rte_mempool_create(
1334 mp_name, /* mempool name */
1335 nb_objs, /* number of elements*/
1336 elt_size, /* element size*/
1337 obj_cache_size, /* Cache size*/
1338 0, /* private data size */
1339 NULL, /* obj initialization constructor */
1340 NULL, /* obj initialization constructor arg */
1341 rte_cryptodev_sym_session_init,
1342 /**< obj constructor*/
1343 dev, /* obj constructor arg */
1344 socket_id, /* socket id */
1347 if (dev->data->session_pool == NULL) {
1348 CDEV_LOG_ERR("%s mempool allocation failed", mp_name);
1353 CDEV_LOG_DEBUG("%s mempool created!", mp_name);
1357 struct rte_cryptodev_sym_session *
1358 rte_cryptodev_sym_session_create(uint8_t dev_id,
1359 struct rte_crypto_sym_xform *xform)
1361 struct rte_cryptodev *dev;
1362 struct rte_cryptodev_sym_session *sess;
1365 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1366 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1370 dev = &rte_crypto_devices[dev_id];
1372 /* Allocate a session structure from the session pool */
1373 if (rte_mempool_get(dev->data->session_pool, &_sess)) {
1374 CDEV_LOG_ERR("Couldn't get object from session mempool");
1378 sess = (struct rte_cryptodev_sym_session *)_sess;
1380 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_configure, NULL);
1381 if (dev->dev_ops->session_configure(dev, xform, sess->_private) ==
1383 CDEV_LOG_ERR("dev_id %d failed to configure session details",
1386 /* Return session to mempool */
1387 rte_mempool_put(sess->mp, _sess);
1394 struct rte_cryptodev_sym_session *
1395 rte_cryptodev_sym_session_free(uint8_t dev_id,
1396 struct rte_cryptodev_sym_session *sess)
1398 struct rte_cryptodev *dev;
1400 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1401 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1405 dev = &rte_crypto_devices[dev_id];
1407 /* Check the session belongs to this device type */
1408 if (sess->dev_type != dev->dev_type)
1411 /* Let device implementation clear session material */
1412 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_clear, sess);
1413 dev->dev_ops->session_clear(dev, (void *)sess->_private);
1415 /* Return session to mempool */
1416 rte_mempool_put(sess->mp, (void *)sess);
1421 /** Initialise rte_crypto_op mempool element */
1423 rte_crypto_op_init(struct rte_mempool *mempool,
1426 __rte_unused unsigned i)
1428 struct rte_crypto_op *op = _op_data;
1429 enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
1431 memset(_op_data, 0, mempool->elt_size);
1433 __rte_crypto_op_reset(op, type);
1435 op->phys_addr = rte_mem_virt2phy(_op_data);
1436 op->mempool = mempool;
1440 struct rte_mempool *
1441 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
1442 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
1445 struct rte_crypto_op_pool_private *priv;
1447 unsigned elt_size = sizeof(struct rte_crypto_op) +
1448 sizeof(struct rte_crypto_sym_op) +
1451 /* lookup mempool in case already allocated */
1452 struct rte_mempool *mp = rte_mempool_lookup(name);
1455 priv = (struct rte_crypto_op_pool_private *)
1456 rte_mempool_get_priv(mp);
1458 if (mp->elt_size != elt_size ||
1459 mp->cache_size < cache_size ||
1460 mp->size < nb_elts ||
1461 priv->priv_size < priv_size) {
1463 CDEV_LOG_ERR("Mempool %s already exists but with "
1464 "incompatible parameters", name);
1470 mp = rte_mempool_create(
1475 sizeof(struct rte_crypto_op_pool_private),
1484 CDEV_LOG_ERR("Failed to create mempool %s", name);
1488 priv = (struct rte_crypto_op_pool_private *)
1489 rte_mempool_get_priv(mp);
1491 priv->priv_size = priv_size;
1498 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix)
1500 struct rte_cryptodev *dev = NULL;
1506 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
1507 int ret = snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
1508 "%s_%u", dev_name_prefix, i);
1513 dev = rte_cryptodev_pmd_get_named_dev(name);