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 * The crypto auth operation strings identifiers.
192 * It could be used in application command line.
195 rte_crypto_auth_operation_strings[] = {
196 [RTE_CRYPTO_AUTH_OP_VERIFY] = "verify",
197 [RTE_CRYPTO_AUTH_OP_GENERATE] = "generate"
201 number_of_sockets(void)
205 const struct rte_memseg *ms = rte_eal_get_physmem_layout();
207 for (i = 0; ((i < RTE_MAX_MEMSEG) && (ms[i].addr != NULL)); i++) {
208 if (sockets < ms[i].socket_id)
209 sockets = ms[i].socket_id;
212 /* Number of sockets = maximum socket_id + 1 */
216 /** Parse integer from integer argument */
218 parse_integer_arg(const char *key __rte_unused,
219 const char *value, void *extra_args)
221 int *i = (int *) extra_args;
225 CDEV_LOG_ERR("Argument has to be positive.");
234 parse_name_arg(const char *key __rte_unused,
235 const char *value, void *extra_args)
237 struct rte_crypto_vdev_init_params *params = extra_args;
239 if (strlen(value) >= RTE_CRYPTODEV_NAME_MAX_LEN - 1) {
240 CDEV_LOG_ERR("Invalid name %s, should be less than "
242 RTE_CRYPTODEV_NAME_MAX_LEN - 1);
246 strncpy(params->name, value, RTE_CRYPTODEV_NAME_MAX_LEN);
252 rte_cryptodev_parse_vdev_init_params(struct rte_crypto_vdev_init_params *params,
253 const char *input_args)
255 struct rte_kvargs *kvlist = NULL;
262 kvlist = rte_kvargs_parse(input_args,
263 cryptodev_vdev_valid_params);
267 ret = rte_kvargs_process(kvlist,
268 RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
270 ¶ms->max_nb_queue_pairs);
274 ret = rte_kvargs_process(kvlist,
275 RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
277 ¶ms->max_nb_sessions);
281 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SOCKET_ID,
287 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_NAME,
293 if (params->socket_id >= number_of_sockets()) {
294 CDEV_LOG_ERR("Invalid socket id specified to create "
295 "the virtual crypto device on");
301 rte_kvargs_free(kvlist);
305 const struct rte_cryptodev_symmetric_capability *
306 rte_cryptodev_sym_capability_get(uint8_t dev_id,
307 const struct rte_cryptodev_sym_capability_idx *idx)
309 const struct rte_cryptodev_capabilities *capability;
310 struct rte_cryptodev_info dev_info;
313 rte_cryptodev_info_get(dev_id, &dev_info);
315 while ((capability = &dev_info.capabilities[i++])->op !=
316 RTE_CRYPTO_OP_TYPE_UNDEFINED) {
317 if (capability->op != RTE_CRYPTO_OP_TYPE_SYMMETRIC)
320 if (capability->sym.xform_type != idx->type)
323 if (idx->type == RTE_CRYPTO_SYM_XFORM_AUTH &&
324 capability->sym.auth.algo == idx->algo.auth)
325 return &capability->sym;
327 if (idx->type == RTE_CRYPTO_SYM_XFORM_CIPHER &&
328 capability->sym.cipher.algo == idx->algo.cipher)
329 return &capability->sym;
336 #define param_range_check(x, y) \
337 (((x < y.min) || (x > y.max)) || \
338 (y.increment != 0 && (x % y.increment) != 0))
341 rte_cryptodev_sym_capability_check_cipher(
342 const struct rte_cryptodev_symmetric_capability *capability,
343 uint16_t key_size, uint16_t iv_size)
345 if (param_range_check(key_size, capability->cipher.key_size))
348 if (param_range_check(iv_size, capability->cipher.iv_size))
355 rte_cryptodev_sym_capability_check_auth(
356 const struct rte_cryptodev_symmetric_capability *capability,
357 uint16_t key_size, uint16_t digest_size, uint16_t aad_size)
359 if (param_range_check(key_size, capability->auth.key_size))
362 if (param_range_check(digest_size, capability->auth.digest_size))
365 if (param_range_check(aad_size, capability->auth.aad_size))
373 rte_cryptodev_get_feature_name(uint64_t flag)
376 case RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO:
377 return "SYMMETRIC_CRYPTO";
378 case RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO:
379 return "ASYMMETRIC_CRYPTO";
380 case RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING:
381 return "SYM_OPERATION_CHAINING";
382 case RTE_CRYPTODEV_FF_CPU_SSE:
384 case RTE_CRYPTODEV_FF_CPU_AVX:
386 case RTE_CRYPTODEV_FF_CPU_AVX2:
388 case RTE_CRYPTODEV_FF_CPU_AESNI:
390 case RTE_CRYPTODEV_FF_HW_ACCELERATED:
391 return "HW_ACCELERATED";
392 case RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER:
393 return "MBUF_SCATTER_GATHER";
394 case RTE_CRYPTODEV_FF_CPU_NEON:
396 case RTE_CRYPTODEV_FF_CPU_ARM_CE:
404 rte_cryptodev_create_vdev(const char *name, const char *args)
406 return rte_eal_vdev_init(name, args);
409 struct rte_cryptodev *
410 rte_cryptodev_pmd_get_dev(uint8_t dev_id)
412 return &rte_cryptodev_globals->devs[dev_id];
415 struct rte_cryptodev *
416 rte_cryptodev_pmd_get_named_dev(const char *name)
418 struct rte_cryptodev *dev;
424 for (i = 0; i < rte_cryptodev_globals->max_devs; i++) {
425 dev = &rte_cryptodev_globals->devs[i];
427 if ((dev->attached == RTE_CRYPTODEV_ATTACHED) &&
428 (strcmp(dev->data->name, name) == 0))
436 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
438 struct rte_cryptodev *dev = NULL;
440 if (dev_id >= rte_cryptodev_globals->nb_devs)
443 dev = rte_cryptodev_pmd_get_dev(dev_id);
444 if (dev->attached != RTE_CRYPTODEV_ATTACHED)
452 rte_cryptodev_get_dev_id(const char *name)
459 for (i = 0; i < rte_cryptodev_globals->nb_devs; i++)
460 if ((strcmp(rte_cryptodev_globals->devs[i].data->name, name)
462 (rte_cryptodev_globals->devs[i].attached ==
463 RTE_CRYPTODEV_ATTACHED))
470 rte_cryptodev_count(void)
472 return rte_cryptodev_globals->nb_devs;
476 rte_cryptodev_count_devtype(enum rte_cryptodev_type type)
478 uint8_t i, dev_count = 0;
480 for (i = 0; i < rte_cryptodev_globals->max_devs; i++)
481 if (rte_cryptodev_globals->devs[i].dev_type == type &&
482 rte_cryptodev_globals->devs[i].attached ==
483 RTE_CRYPTODEV_ATTACHED)
490 rte_cryptodev_devices_get(const char *dev_name, uint8_t *devices,
493 uint8_t i, count = 0;
494 struct rte_cryptodev *devs = rte_cryptodev_globals->devs;
495 uint8_t max_devs = rte_cryptodev_globals->max_devs;
497 for (i = 0; i < max_devs && count < nb_devices; i++) {
499 if (devs[i].attached == RTE_CRYPTODEV_ATTACHED) {
500 const struct rte_cryptodev_driver *drv = devs[i].driver;
504 cmp = strncmp(drv->pci_drv.driver.name,
505 dev_name, strlen(dev_name));
507 cmp = strncmp(devs[i].data->name,
508 dev_name, strlen(dev_name));
511 devices[count++] = devs[i].data->dev_id;
519 rte_cryptodev_socket_id(uint8_t dev_id)
521 struct rte_cryptodev *dev;
523 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
526 dev = rte_cryptodev_pmd_get_dev(dev_id);
528 return dev->data->socket_id;
532 rte_cryptodev_data_alloc(uint8_t dev_id, struct rte_cryptodev_data **data,
535 char mz_name[RTE_CRYPTODEV_NAME_MAX_LEN];
536 const struct rte_memzone *mz;
539 /* generate memzone name */
540 n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
541 if (n >= (int)sizeof(mz_name))
544 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
545 mz = rte_memzone_reserve(mz_name,
546 sizeof(struct rte_cryptodev_data),
549 mz = rte_memzone_lookup(mz_name);
555 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
556 memset(*data, 0, sizeof(struct rte_cryptodev_data));
562 rte_cryptodev_find_free_device_index(void)
566 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) {
567 if (rte_crypto_devices[dev_id].attached ==
568 RTE_CRYPTODEV_DETACHED)
571 return RTE_CRYPTO_MAX_DEVS;
574 struct rte_cryptodev *
575 rte_cryptodev_pmd_allocate(const char *name, int socket_id)
577 struct rte_cryptodev *cryptodev;
580 if (rte_cryptodev_pmd_get_named_dev(name) != NULL) {
581 CDEV_LOG_ERR("Crypto device with name %s already "
586 dev_id = rte_cryptodev_find_free_device_index();
587 if (dev_id == RTE_CRYPTO_MAX_DEVS) {
588 CDEV_LOG_ERR("Reached maximum number of crypto devices");
592 cryptodev = rte_cryptodev_pmd_get_dev(dev_id);
594 if (cryptodev->data == NULL) {
595 struct rte_cryptodev_data *cryptodev_data =
596 cryptodev_globals.data[dev_id];
598 int retval = rte_cryptodev_data_alloc(dev_id, &cryptodev_data,
601 if (retval < 0 || cryptodev_data == NULL)
604 cryptodev->data = cryptodev_data;
606 snprintf(cryptodev->data->name, RTE_CRYPTODEV_NAME_MAX_LEN,
609 cryptodev->data->dev_id = dev_id;
610 cryptodev->data->socket_id = socket_id;
611 cryptodev->data->dev_started = 0;
613 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
615 cryptodev_globals.nb_devs++;
622 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
626 if (cryptodev == NULL)
629 ret = rte_cryptodev_close(cryptodev->data->dev_id);
633 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
634 cryptodev_globals.nb_devs--;
638 struct rte_cryptodev *
639 rte_cryptodev_pmd_virtual_dev_init(const char *name, size_t dev_private_size,
642 struct rte_cryptodev *cryptodev;
644 /* allocate device structure */
645 cryptodev = rte_cryptodev_pmd_allocate(name, socket_id);
646 if (cryptodev == NULL)
649 /* allocate private device structure */
650 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
651 cryptodev->data->dev_private =
652 rte_zmalloc_socket("cryptodev device private",
657 if (cryptodev->data->dev_private == NULL)
658 rte_panic("Cannot allocate memzone for private device"
662 /* initialise user call-back tail queue */
663 TAILQ_INIT(&(cryptodev->link_intr_cbs));
669 rte_cryptodev_pci_probe(struct rte_pci_driver *pci_drv,
670 struct rte_pci_device *pci_dev)
672 struct rte_cryptodev_driver *cryptodrv;
673 struct rte_cryptodev *cryptodev;
675 char cryptodev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
679 cryptodrv = (struct rte_cryptodev_driver *)pci_drv;
680 if (cryptodrv == NULL)
683 rte_eal_pci_device_name(&pci_dev->addr, cryptodev_name,
684 sizeof(cryptodev_name));
686 cryptodev = rte_cryptodev_pmd_allocate(cryptodev_name, rte_socket_id());
687 if (cryptodev == NULL)
690 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
691 cryptodev->data->dev_private =
693 "cryptodev private structure",
694 cryptodrv->dev_private_size,
698 if (cryptodev->data->dev_private == NULL)
699 rte_panic("Cannot allocate memzone for private "
703 cryptodev->device = &pci_dev->device;
704 cryptodev->driver = cryptodrv;
706 /* init user callbacks */
707 TAILQ_INIT(&(cryptodev->link_intr_cbs));
709 /* Invoke PMD device initialization function */
710 retval = (*cryptodrv->cryptodev_init)(cryptodrv, cryptodev);
714 CDEV_LOG_ERR("driver %s: crypto_dev_init(vendor_id=0x%x device_id=0x%x)"
715 " failed", pci_drv->driver.name,
716 (unsigned) pci_dev->id.vendor_id,
717 (unsigned) pci_dev->id.device_id);
719 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
720 rte_free(cryptodev->data->dev_private);
722 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
723 cryptodev_globals.nb_devs--;
729 rte_cryptodev_pci_remove(struct rte_pci_device *pci_dev)
731 const struct rte_cryptodev_driver *cryptodrv;
732 struct rte_cryptodev *cryptodev;
733 char cryptodev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
739 rte_eal_pci_device_name(&pci_dev->addr, cryptodev_name,
740 sizeof(cryptodev_name));
742 cryptodev = rte_cryptodev_pmd_get_named_dev(cryptodev_name);
743 if (cryptodev == NULL)
746 cryptodrv = (const struct rte_cryptodev_driver *)pci_dev->driver;
747 if (cryptodrv == NULL)
750 /* Invoke PMD device uninit function */
751 if (*cryptodrv->cryptodev_uninit) {
752 ret = (*cryptodrv->cryptodev_uninit)(cryptodrv, cryptodev);
757 /* free crypto device */
758 rte_cryptodev_pmd_release_device(cryptodev);
760 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
761 rte_free(cryptodev->data->dev_private);
763 cryptodev->device = NULL;
764 cryptodev->driver = NULL;
765 cryptodev->data = NULL;
771 rte_cryptodev_queue_pair_count(uint8_t dev_id)
773 struct rte_cryptodev *dev;
775 dev = &rte_crypto_devices[dev_id];
776 return dev->data->nb_queue_pairs;
780 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
783 struct rte_cryptodev_info dev_info;
787 if ((dev == NULL) || (nb_qpairs < 1)) {
788 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
793 CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
794 nb_qpairs, dev->data->dev_id);
796 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
798 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
799 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
801 if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
802 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
803 nb_qpairs, dev->data->dev_id);
807 if (dev->data->queue_pairs == NULL) { /* first time configuration */
808 dev->data->queue_pairs = rte_zmalloc_socket(
809 "cryptodev->queue_pairs",
810 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
811 RTE_CACHE_LINE_SIZE, socket_id);
813 if (dev->data->queue_pairs == NULL) {
814 dev->data->nb_queue_pairs = 0;
815 CDEV_LOG_ERR("failed to get memory for qp meta data, "
820 } else { /* re-configure */
822 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
824 qp = dev->data->queue_pairs;
826 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
829 for (i = nb_qpairs; i < old_nb_queues; i++) {
830 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
835 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
836 RTE_CACHE_LINE_SIZE);
838 CDEV_LOG_ERR("failed to realloc qp meta data,"
839 " nb_queues %u", nb_qpairs);
843 if (nb_qpairs > old_nb_queues) {
844 uint16_t new_qs = nb_qpairs - old_nb_queues;
846 memset(qp + old_nb_queues, 0,
847 sizeof(qp[0]) * new_qs);
850 dev->data->queue_pairs = qp;
853 dev->data->nb_queue_pairs = nb_qpairs;
858 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id)
860 struct rte_cryptodev *dev;
862 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
863 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
867 dev = &rte_crypto_devices[dev_id];
868 if (queue_pair_id >= dev->data->nb_queue_pairs) {
869 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
873 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_start, -ENOTSUP);
875 return dev->dev_ops->queue_pair_start(dev, queue_pair_id);
880 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id)
882 struct rte_cryptodev *dev;
884 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
885 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
889 dev = &rte_crypto_devices[dev_id];
890 if (queue_pair_id >= dev->data->nb_queue_pairs) {
891 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
895 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_stop, -ENOTSUP);
897 return dev->dev_ops->queue_pair_stop(dev, queue_pair_id);
902 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
903 unsigned nb_objs, unsigned obj_cache_size, int socket_id);
906 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
908 struct rte_cryptodev *dev;
911 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
912 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
916 dev = &rte_crypto_devices[dev_id];
918 if (dev->data->dev_started) {
920 "device %d must be stopped to allow configuration", dev_id);
924 /* Setup new number of queue pairs and reconfigure device. */
925 diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
928 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
933 /* Setup Session mempool for device */
934 return rte_cryptodev_sym_session_pool_create(dev,
935 config->session_mp.nb_objs,
936 config->session_mp.cache_size,
942 rte_cryptodev_start(uint8_t dev_id)
944 struct rte_cryptodev *dev;
947 CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
949 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
950 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
954 dev = &rte_crypto_devices[dev_id];
956 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
958 if (dev->data->dev_started != 0) {
959 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
964 diag = (*dev->dev_ops->dev_start)(dev);
966 dev->data->dev_started = 1;
974 rte_cryptodev_stop(uint8_t dev_id)
976 struct rte_cryptodev *dev;
978 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
979 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
983 dev = &rte_crypto_devices[dev_id];
985 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
987 if (dev->data->dev_started == 0) {
988 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
993 dev->data->dev_started = 0;
994 (*dev->dev_ops->dev_stop)(dev);
998 rte_cryptodev_close(uint8_t dev_id)
1000 struct rte_cryptodev *dev;
1003 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1004 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1008 dev = &rte_crypto_devices[dev_id];
1010 /* Device must be stopped before it can be closed */
1011 if (dev->data->dev_started == 1) {
1012 CDEV_LOG_ERR("Device %u must be stopped before closing",
1017 /* We can't close the device if there are outstanding sessions in use */
1018 if (dev->data->session_pool != NULL) {
1019 if (!rte_mempool_full(dev->data->session_pool)) {
1020 CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
1021 "has sessions still in use, free "
1022 "all sessions before calling close",
1028 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
1029 retval = (*dev->dev_ops->dev_close)(dev);
1038 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
1039 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id)
1041 struct rte_cryptodev *dev;
1043 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1044 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1048 dev = &rte_crypto_devices[dev_id];
1049 if (queue_pair_id >= dev->data->nb_queue_pairs) {
1050 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
1054 if (dev->data->dev_started) {
1056 "device %d must be stopped to allow configuration", dev_id);
1060 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
1062 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
1068 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
1070 struct rte_cryptodev *dev;
1072 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1073 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1077 if (stats == NULL) {
1078 CDEV_LOG_ERR("Invalid stats ptr");
1082 dev = &rte_crypto_devices[dev_id];
1083 memset(stats, 0, sizeof(*stats));
1085 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
1086 (*dev->dev_ops->stats_get)(dev, stats);
1091 rte_cryptodev_stats_reset(uint8_t dev_id)
1093 struct rte_cryptodev *dev;
1095 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1096 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1100 dev = &rte_crypto_devices[dev_id];
1102 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
1103 (*dev->dev_ops->stats_reset)(dev);
1108 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
1110 struct rte_cryptodev *dev;
1112 if (dev_id >= cryptodev_globals.nb_devs) {
1113 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1117 dev = &rte_crypto_devices[dev_id];
1119 memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
1121 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
1122 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
1124 dev_info->pci_dev = RTE_DEV_TO_PCI(dev->device);
1126 dev_info->driver_name = dev->driver->pci_drv.driver.name;
1131 rte_cryptodev_callback_register(uint8_t dev_id,
1132 enum rte_cryptodev_event_type event,
1133 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1135 struct rte_cryptodev *dev;
1136 struct rte_cryptodev_callback *user_cb;
1141 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1142 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1146 dev = &rte_crypto_devices[dev_id];
1147 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1149 TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
1150 if (user_cb->cb_fn == cb_fn &&
1151 user_cb->cb_arg == cb_arg &&
1152 user_cb->event == event) {
1157 /* create a new callback. */
1158 if (user_cb == NULL) {
1159 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
1160 sizeof(struct rte_cryptodev_callback), 0);
1161 if (user_cb != NULL) {
1162 user_cb->cb_fn = cb_fn;
1163 user_cb->cb_arg = cb_arg;
1164 user_cb->event = event;
1165 TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
1169 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1170 return (user_cb == NULL) ? -ENOMEM : 0;
1174 rte_cryptodev_callback_unregister(uint8_t dev_id,
1175 enum rte_cryptodev_event_type event,
1176 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1179 struct rte_cryptodev *dev;
1180 struct rte_cryptodev_callback *cb, *next;
1185 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1186 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1190 dev = &rte_crypto_devices[dev_id];
1191 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1194 for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
1196 next = TAILQ_NEXT(cb, next);
1198 if (cb->cb_fn != cb_fn || cb->event != event ||
1199 (cb->cb_arg != (void *)-1 &&
1200 cb->cb_arg != cb_arg))
1204 * if this callback is not executing right now,
1207 if (cb->active == 0) {
1208 TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
1215 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1220 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
1221 enum rte_cryptodev_event_type event)
1223 struct rte_cryptodev_callback *cb_lst;
1224 struct rte_cryptodev_callback dev_cb;
1226 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1227 TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
1228 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
1232 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1233 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
1235 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1238 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1243 rte_cryptodev_sym_session_init(struct rte_mempool *mp,
1246 __rte_unused unsigned i)
1248 struct rte_cryptodev_sym_session *sess = _sess;
1249 struct rte_cryptodev *dev = opaque_arg;
1251 memset(sess, 0, mp->elt_size);
1253 sess->dev_id = dev->data->dev_id;
1254 sess->dev_type = dev->dev_type;
1257 if (dev->dev_ops->session_initialize)
1258 (*dev->dev_ops->session_initialize)(mp, sess);
1262 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
1263 unsigned nb_objs, unsigned obj_cache_size, int socket_id)
1265 char mp_name[RTE_CRYPTODEV_NAME_MAX_LEN];
1266 unsigned priv_sess_size;
1268 unsigned n = snprintf(mp_name, sizeof(mp_name), "cdev_%d_sess_mp",
1270 if (n > sizeof(mp_name)) {
1271 CDEV_LOG_ERR("Unable to create unique name for session mempool");
1275 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_get_size, -ENOTSUP);
1276 priv_sess_size = (*dev->dev_ops->session_get_size)(dev);
1277 if (priv_sess_size == 0) {
1278 CDEV_LOG_ERR("%s returned and invalid private session size ",
1283 unsigned elt_size = sizeof(struct rte_cryptodev_sym_session) +
1286 dev->data->session_pool = rte_mempool_lookup(mp_name);
1287 if (dev->data->session_pool != NULL) {
1288 if ((dev->data->session_pool->elt_size != elt_size) ||
1289 (dev->data->session_pool->cache_size <
1291 (dev->data->session_pool->size < nb_objs)) {
1293 CDEV_LOG_ERR("%s mempool already exists with different"
1294 " initialization parameters", mp_name);
1295 dev->data->session_pool = NULL;
1299 dev->data->session_pool = rte_mempool_create(
1300 mp_name, /* mempool name */
1301 nb_objs, /* number of elements*/
1302 elt_size, /* element size*/
1303 obj_cache_size, /* Cache size*/
1304 0, /* private data size */
1305 NULL, /* obj initialization constructor */
1306 NULL, /* obj initialization constructor arg */
1307 rte_cryptodev_sym_session_init,
1308 /**< obj constructor*/
1309 dev, /* obj constructor arg */
1310 socket_id, /* socket id */
1313 if (dev->data->session_pool == NULL) {
1314 CDEV_LOG_ERR("%s mempool allocation failed", mp_name);
1319 CDEV_LOG_DEBUG("%s mempool created!", mp_name);
1323 struct rte_cryptodev_sym_session *
1324 rte_cryptodev_sym_session_create(uint8_t dev_id,
1325 struct rte_crypto_sym_xform *xform)
1327 struct rte_cryptodev *dev;
1328 struct rte_cryptodev_sym_session *sess;
1331 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1332 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1336 dev = &rte_crypto_devices[dev_id];
1338 /* Allocate a session structure from the session pool */
1339 if (rte_mempool_get(dev->data->session_pool, &_sess)) {
1340 CDEV_LOG_ERR("Couldn't get object from session mempool");
1344 sess = (struct rte_cryptodev_sym_session *)_sess;
1346 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_configure, NULL);
1347 if (dev->dev_ops->session_configure(dev, xform, sess->_private) ==
1349 CDEV_LOG_ERR("dev_id %d failed to configure session details",
1352 /* Return session to mempool */
1353 rte_mempool_put(sess->mp, _sess);
1360 struct rte_cryptodev_sym_session *
1361 rte_cryptodev_sym_session_free(uint8_t dev_id,
1362 struct rte_cryptodev_sym_session *sess)
1364 struct rte_cryptodev *dev;
1366 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1367 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1371 dev = &rte_crypto_devices[dev_id];
1373 /* Check the session belongs to this device type */
1374 if (sess->dev_type != dev->dev_type)
1377 /* Let device implementation clear session material */
1378 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_clear, sess);
1379 dev->dev_ops->session_clear(dev, (void *)sess->_private);
1381 /* Return session to mempool */
1382 rte_mempool_put(sess->mp, (void *)sess);
1387 /** Initialise rte_crypto_op mempool element */
1389 rte_crypto_op_init(struct rte_mempool *mempool,
1392 __rte_unused unsigned i)
1394 struct rte_crypto_op *op = _op_data;
1395 enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
1397 memset(_op_data, 0, mempool->elt_size);
1399 __rte_crypto_op_reset(op, type);
1401 op->phys_addr = rte_mem_virt2phy(_op_data);
1402 op->mempool = mempool;
1406 struct rte_mempool *
1407 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
1408 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
1411 struct rte_crypto_op_pool_private *priv;
1413 unsigned elt_size = sizeof(struct rte_crypto_op) +
1414 sizeof(struct rte_crypto_sym_op) +
1417 /* lookup mempool in case already allocated */
1418 struct rte_mempool *mp = rte_mempool_lookup(name);
1421 priv = (struct rte_crypto_op_pool_private *)
1422 rte_mempool_get_priv(mp);
1424 if (mp->elt_size != elt_size ||
1425 mp->cache_size < cache_size ||
1426 mp->size < nb_elts ||
1427 priv->priv_size < priv_size) {
1429 CDEV_LOG_ERR("Mempool %s already exists but with "
1430 "incompatible parameters", name);
1436 mp = rte_mempool_create(
1441 sizeof(struct rte_crypto_op_pool_private),
1450 CDEV_LOG_ERR("Failed to create mempool %s", name);
1454 priv = (struct rte_crypto_op_pool_private *)
1455 rte_mempool_get_priv(mp);
1457 priv->priv_size = priv_size;
1464 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix)
1466 struct rte_cryptodev *dev = NULL;
1472 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
1473 int ret = snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
1474 "%s_%u", dev_name_prefix, i);
1479 dev = rte_cryptodev_pmd_get_named_dev(name);