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_NULL] = "null",
138 [RTE_CRYPTO_CIPHER_KASUMI_F8] = "kasumi-f8",
139 [RTE_CRYPTO_CIPHER_SNOW3G_UEA2] = "snow3g-uea2",
140 [RTE_CRYPTO_CIPHER_ZUC_EEA3] = "zuc-eea3"
144 * The crypto cipher operation strings identifiers.
145 * It could be used in application command line.
148 rte_crypto_cipher_operation_strings[] = {
149 [RTE_CRYPTO_CIPHER_OP_ENCRYPT] = "encrypt",
150 [RTE_CRYPTO_CIPHER_OP_DECRYPT] = "decrypt"
154 * The crypto auth algorithm strings identifiers.
155 * It could be used in application command line.
158 rte_crypto_auth_algorithm_strings[] = {
159 [RTE_CRYPTO_AUTH_AES_CBC_MAC] = "aes-cbc-mac",
160 [RTE_CRYPTO_AUTH_AES_CCM] = "aes-ccm",
161 [RTE_CRYPTO_AUTH_AES_CMAC] = "aes-cmac",
162 [RTE_CRYPTO_AUTH_AES_GCM] = "aes-gcm",
163 [RTE_CRYPTO_AUTH_AES_GMAC] = "aes-gmac",
164 [RTE_CRYPTO_AUTH_AES_XCBC_MAC] = "aes-xcbc-mac",
166 [RTE_CRYPTO_AUTH_MD5] = "md5",
167 [RTE_CRYPTO_AUTH_MD5_HMAC] = "md5-hmac",
169 [RTE_CRYPTO_AUTH_SHA1] = "sha1",
170 [RTE_CRYPTO_AUTH_SHA1_HMAC] = "sha1-hmac",
172 [RTE_CRYPTO_AUTH_SHA224] = "sha2-224",
173 [RTE_CRYPTO_AUTH_SHA224_HMAC] = "sha2-224-hmac",
174 [RTE_CRYPTO_AUTH_SHA256] = "sha2-256",
175 [RTE_CRYPTO_AUTH_SHA256_HMAC] = "sha2-256-hmac",
176 [RTE_CRYPTO_AUTH_SHA384] = "sha2-384",
177 [RTE_CRYPTO_AUTH_SHA384_HMAC] = "sha2-384-hmac",
178 [RTE_CRYPTO_AUTH_SHA512] = "sha2-512",
179 [RTE_CRYPTO_AUTH_SHA512_HMAC] = "sha2-512-hmac",
181 [RTE_CRYPTO_AUTH_KASUMI_F9] = "kasumi-f9",
182 [RTE_CRYPTO_AUTH_SNOW3G_UIA2] = "snow3g-uia2",
183 [RTE_CRYPTO_AUTH_ZUC_EIA3] = "zuc-eia3"
187 * The crypto auth operation strings identifiers.
188 * It could be used in application command line.
191 rte_crypto_auth_operation_strings[] = {
192 [RTE_CRYPTO_AUTH_OP_VERIFY] = "verify",
193 [RTE_CRYPTO_AUTH_OP_GENERATE] = "generate"
197 number_of_sockets(void)
201 const struct rte_memseg *ms = rte_eal_get_physmem_layout();
203 for (i = 0; ((i < RTE_MAX_MEMSEG) && (ms[i].addr != NULL)); i++) {
204 if (sockets < ms[i].socket_id)
205 sockets = ms[i].socket_id;
208 /* Number of sockets = maximum socket_id + 1 */
212 /** Parse integer from integer argument */
214 parse_integer_arg(const char *key __rte_unused,
215 const char *value, void *extra_args)
217 int *i = (int *) extra_args;
221 CDEV_LOG_ERR("Argument has to be positive.");
230 parse_name_arg(const char *key __rte_unused,
231 const char *value, void *extra_args)
233 struct rte_crypto_vdev_init_params *params = extra_args;
235 if (strlen(value) >= RTE_CRYPTODEV_NAME_MAX_LEN - 1) {
236 CDEV_LOG_ERR("Invalid name %s, should be less than "
238 RTE_CRYPTODEV_NAME_MAX_LEN - 1);
242 strncpy(params->name, value, RTE_CRYPTODEV_NAME_MAX_LEN);
248 rte_cryptodev_parse_vdev_init_params(struct rte_crypto_vdev_init_params *params,
249 const char *input_args)
251 struct rte_kvargs *kvlist = NULL;
258 kvlist = rte_kvargs_parse(input_args,
259 cryptodev_vdev_valid_params);
263 ret = rte_kvargs_process(kvlist,
264 RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
266 ¶ms->max_nb_queue_pairs);
270 ret = rte_kvargs_process(kvlist,
271 RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
273 ¶ms->max_nb_sessions);
277 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SOCKET_ID,
283 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_NAME,
289 if (params->socket_id >= number_of_sockets()) {
290 CDEV_LOG_ERR("Invalid socket id specified to create "
291 "the virtual crypto device on");
297 rte_kvargs_free(kvlist);
301 const struct rte_cryptodev_symmetric_capability *
302 rte_cryptodev_sym_capability_get(uint8_t dev_id,
303 const struct rte_cryptodev_sym_capability_idx *idx)
305 const struct rte_cryptodev_capabilities *capability;
306 struct rte_cryptodev_info dev_info;
309 rte_cryptodev_info_get(dev_id, &dev_info);
311 while ((capability = &dev_info.capabilities[i++])->op !=
312 RTE_CRYPTO_OP_TYPE_UNDEFINED) {
313 if (capability->op != RTE_CRYPTO_OP_TYPE_SYMMETRIC)
316 if (capability->sym.xform_type != idx->type)
319 if (idx->type == RTE_CRYPTO_SYM_XFORM_AUTH &&
320 capability->sym.auth.algo == idx->algo.auth)
321 return &capability->sym;
323 if (idx->type == RTE_CRYPTO_SYM_XFORM_CIPHER &&
324 capability->sym.cipher.algo == idx->algo.cipher)
325 return &capability->sym;
332 #define param_range_check(x, y) \
333 (((x < y.min) || (x > y.max)) || \
334 (y.increment != 0 && (x % y.increment) != 0))
337 rte_cryptodev_sym_capability_check_cipher(
338 const struct rte_cryptodev_symmetric_capability *capability,
339 uint16_t key_size, uint16_t iv_size)
341 if (param_range_check(key_size, capability->cipher.key_size))
344 if (param_range_check(iv_size, capability->cipher.iv_size))
351 rte_cryptodev_sym_capability_check_auth(
352 const struct rte_cryptodev_symmetric_capability *capability,
353 uint16_t key_size, uint16_t digest_size, uint16_t aad_size)
355 if (param_range_check(key_size, capability->auth.key_size))
358 if (param_range_check(digest_size, capability->auth.digest_size))
361 if (param_range_check(aad_size, capability->auth.aad_size))
369 rte_cryptodev_get_feature_name(uint64_t flag)
372 case RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO:
373 return "SYMMETRIC_CRYPTO";
374 case RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO:
375 return "ASYMMETRIC_CRYPTO";
376 case RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING:
377 return "SYM_OPERATION_CHAINING";
378 case RTE_CRYPTODEV_FF_CPU_SSE:
380 case RTE_CRYPTODEV_FF_CPU_AVX:
382 case RTE_CRYPTODEV_FF_CPU_AVX2:
384 case RTE_CRYPTODEV_FF_CPU_AESNI:
386 case RTE_CRYPTODEV_FF_HW_ACCELERATED:
387 return "HW_ACCELERATED";
388 case RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER:
389 return "MBUF_SCATTER_GATHER";
390 case RTE_CRYPTODEV_FF_CPU_NEON:
392 case RTE_CRYPTODEV_FF_CPU_ARM_CE:
400 rte_cryptodev_create_vdev(const char *name, const char *args)
402 return rte_eal_vdev_init(name, args);
405 struct rte_cryptodev *
406 rte_cryptodev_pmd_get_dev(uint8_t dev_id)
408 return &rte_cryptodev_globals->devs[dev_id];
411 struct rte_cryptodev *
412 rte_cryptodev_pmd_get_named_dev(const char *name)
414 struct rte_cryptodev *dev;
420 for (i = 0; i < rte_cryptodev_globals->max_devs; i++) {
421 dev = &rte_cryptodev_globals->devs[i];
423 if ((dev->attached == RTE_CRYPTODEV_ATTACHED) &&
424 (strcmp(dev->data->name, name) == 0))
432 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
434 struct rte_cryptodev *dev = NULL;
436 if (dev_id >= rte_cryptodev_globals->nb_devs)
439 dev = rte_cryptodev_pmd_get_dev(dev_id);
440 if (dev->attached != RTE_CRYPTODEV_ATTACHED)
448 rte_cryptodev_get_dev_id(const char *name)
455 for (i = 0; i < rte_cryptodev_globals->nb_devs; i++)
456 if ((strcmp(rte_cryptodev_globals->devs[i].data->name, name)
458 (rte_cryptodev_globals->devs[i].attached ==
459 RTE_CRYPTODEV_ATTACHED))
466 rte_cryptodev_count(void)
468 return rte_cryptodev_globals->nb_devs;
472 rte_cryptodev_count_devtype(enum rte_cryptodev_type type)
474 uint8_t i, dev_count = 0;
476 for (i = 0; i < rte_cryptodev_globals->max_devs; i++)
477 if (rte_cryptodev_globals->devs[i].dev_type == type &&
478 rte_cryptodev_globals->devs[i].attached ==
479 RTE_CRYPTODEV_ATTACHED)
486 rte_cryptodev_devices_get(const char *dev_name, uint8_t *devices,
489 uint8_t i, count = 0;
490 struct rte_cryptodev *devs = rte_cryptodev_globals->devs;
491 uint8_t max_devs = rte_cryptodev_globals->max_devs;
493 for (i = 0; i < max_devs && count < nb_devices; i++) {
495 if (devs[i].attached == RTE_CRYPTODEV_ATTACHED) {
496 const struct rte_cryptodev_driver *drv = devs[i].driver;
500 cmp = strncmp(drv->pci_drv.driver.name,
501 dev_name, strlen(dev_name));
503 cmp = strncmp(devs[i].data->name,
504 dev_name, strlen(dev_name));
507 devices[count++] = devs[i].data->dev_id;
515 rte_cryptodev_socket_id(uint8_t dev_id)
517 struct rte_cryptodev *dev;
519 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
522 dev = rte_cryptodev_pmd_get_dev(dev_id);
524 return dev->data->socket_id;
528 rte_cryptodev_data_alloc(uint8_t dev_id, struct rte_cryptodev_data **data,
531 char mz_name[RTE_CRYPTODEV_NAME_MAX_LEN];
532 const struct rte_memzone *mz;
535 /* generate memzone name */
536 n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
537 if (n >= (int)sizeof(mz_name))
540 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
541 mz = rte_memzone_reserve(mz_name,
542 sizeof(struct rte_cryptodev_data),
545 mz = rte_memzone_lookup(mz_name);
551 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
552 memset(*data, 0, sizeof(struct rte_cryptodev_data));
558 rte_cryptodev_find_free_device_index(void)
562 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) {
563 if (rte_crypto_devices[dev_id].attached ==
564 RTE_CRYPTODEV_DETACHED)
567 return RTE_CRYPTO_MAX_DEVS;
570 struct rte_cryptodev *
571 rte_cryptodev_pmd_allocate(const char *name, int socket_id)
573 struct rte_cryptodev *cryptodev;
576 if (rte_cryptodev_pmd_get_named_dev(name) != NULL) {
577 CDEV_LOG_ERR("Crypto device with name %s already "
582 dev_id = rte_cryptodev_find_free_device_index();
583 if (dev_id == RTE_CRYPTO_MAX_DEVS) {
584 CDEV_LOG_ERR("Reached maximum number of crypto devices");
588 cryptodev = rte_cryptodev_pmd_get_dev(dev_id);
590 if (cryptodev->data == NULL) {
591 struct rte_cryptodev_data *cryptodev_data =
592 cryptodev_globals.data[dev_id];
594 int retval = rte_cryptodev_data_alloc(dev_id, &cryptodev_data,
597 if (retval < 0 || cryptodev_data == NULL)
600 cryptodev->data = cryptodev_data;
602 snprintf(cryptodev->data->name, RTE_CRYPTODEV_NAME_MAX_LEN,
605 cryptodev->data->dev_id = dev_id;
606 cryptodev->data->socket_id = socket_id;
607 cryptodev->data->dev_started = 0;
609 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
611 cryptodev_globals.nb_devs++;
618 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
622 if (cryptodev == NULL)
625 ret = rte_cryptodev_close(cryptodev->data->dev_id);
629 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
630 cryptodev_globals.nb_devs--;
634 struct rte_cryptodev *
635 rte_cryptodev_pmd_virtual_dev_init(const char *name, size_t dev_private_size,
638 struct rte_cryptodev *cryptodev;
640 /* allocate device structure */
641 cryptodev = rte_cryptodev_pmd_allocate(name, socket_id);
642 if (cryptodev == NULL)
645 /* allocate private device structure */
646 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
647 cryptodev->data->dev_private =
648 rte_zmalloc_socket("cryptodev device private",
653 if (cryptodev->data->dev_private == NULL)
654 rte_panic("Cannot allocate memzone for private device"
658 /* initialise user call-back tail queue */
659 TAILQ_INIT(&(cryptodev->link_intr_cbs));
665 rte_cryptodev_pci_probe(struct rte_pci_driver *pci_drv,
666 struct rte_pci_device *pci_dev)
668 struct rte_cryptodev_driver *cryptodrv;
669 struct rte_cryptodev *cryptodev;
671 char cryptodev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
675 cryptodrv = (struct rte_cryptodev_driver *)pci_drv;
676 if (cryptodrv == NULL)
679 rte_eal_pci_device_name(&pci_dev->addr, cryptodev_name,
680 sizeof(cryptodev_name));
682 cryptodev = rte_cryptodev_pmd_allocate(cryptodev_name, rte_socket_id());
683 if (cryptodev == NULL)
686 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
687 cryptodev->data->dev_private =
689 "cryptodev private structure",
690 cryptodrv->dev_private_size,
694 if (cryptodev->data->dev_private == NULL)
695 rte_panic("Cannot allocate memzone for private "
699 cryptodev->device = &pci_dev->device;
700 cryptodev->driver = cryptodrv;
702 /* init user callbacks */
703 TAILQ_INIT(&(cryptodev->link_intr_cbs));
705 /* Invoke PMD device initialization function */
706 retval = (*cryptodrv->cryptodev_init)(cryptodrv, cryptodev);
710 CDEV_LOG_ERR("driver %s: crypto_dev_init(vendor_id=0x%x device_id=0x%x)"
711 " failed", pci_drv->driver.name,
712 (unsigned) pci_dev->id.vendor_id,
713 (unsigned) pci_dev->id.device_id);
715 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
716 rte_free(cryptodev->data->dev_private);
718 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
719 cryptodev_globals.nb_devs--;
725 rte_cryptodev_pci_remove(struct rte_pci_device *pci_dev)
727 const struct rte_cryptodev_driver *cryptodrv;
728 struct rte_cryptodev *cryptodev;
729 char cryptodev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
735 rte_eal_pci_device_name(&pci_dev->addr, cryptodev_name,
736 sizeof(cryptodev_name));
738 cryptodev = rte_cryptodev_pmd_get_named_dev(cryptodev_name);
739 if (cryptodev == NULL)
742 cryptodrv = (const struct rte_cryptodev_driver *)pci_dev->driver;
743 if (cryptodrv == NULL)
746 /* Invoke PMD device uninit function */
747 if (*cryptodrv->cryptodev_uninit) {
748 ret = (*cryptodrv->cryptodev_uninit)(cryptodrv, cryptodev);
753 /* free crypto device */
754 rte_cryptodev_pmd_release_device(cryptodev);
756 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
757 rte_free(cryptodev->data->dev_private);
759 cryptodev->device = NULL;
760 cryptodev->driver = NULL;
761 cryptodev->data = NULL;
767 rte_cryptodev_queue_pair_count(uint8_t dev_id)
769 struct rte_cryptodev *dev;
771 dev = &rte_crypto_devices[dev_id];
772 return dev->data->nb_queue_pairs;
776 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
779 struct rte_cryptodev_info dev_info;
783 if ((dev == NULL) || (nb_qpairs < 1)) {
784 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
789 CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
790 nb_qpairs, dev->data->dev_id);
792 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
794 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
795 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
797 if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
798 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
799 nb_qpairs, dev->data->dev_id);
803 if (dev->data->queue_pairs == NULL) { /* first time configuration */
804 dev->data->queue_pairs = rte_zmalloc_socket(
805 "cryptodev->queue_pairs",
806 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
807 RTE_CACHE_LINE_SIZE, socket_id);
809 if (dev->data->queue_pairs == NULL) {
810 dev->data->nb_queue_pairs = 0;
811 CDEV_LOG_ERR("failed to get memory for qp meta data, "
816 } else { /* re-configure */
818 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
820 qp = dev->data->queue_pairs;
822 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
825 for (i = nb_qpairs; i < old_nb_queues; i++) {
826 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
831 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
832 RTE_CACHE_LINE_SIZE);
834 CDEV_LOG_ERR("failed to realloc qp meta data,"
835 " nb_queues %u", nb_qpairs);
839 if (nb_qpairs > old_nb_queues) {
840 uint16_t new_qs = nb_qpairs - old_nb_queues;
842 memset(qp + old_nb_queues, 0,
843 sizeof(qp[0]) * new_qs);
846 dev->data->queue_pairs = qp;
849 dev->data->nb_queue_pairs = nb_qpairs;
854 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id)
856 struct rte_cryptodev *dev;
858 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
859 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
863 dev = &rte_crypto_devices[dev_id];
864 if (queue_pair_id >= dev->data->nb_queue_pairs) {
865 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
869 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_start, -ENOTSUP);
871 return dev->dev_ops->queue_pair_start(dev, queue_pair_id);
876 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id)
878 struct rte_cryptodev *dev;
880 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
881 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
885 dev = &rte_crypto_devices[dev_id];
886 if (queue_pair_id >= dev->data->nb_queue_pairs) {
887 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
891 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_stop, -ENOTSUP);
893 return dev->dev_ops->queue_pair_stop(dev, queue_pair_id);
898 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
899 unsigned nb_objs, unsigned obj_cache_size, int socket_id);
902 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
904 struct rte_cryptodev *dev;
907 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
908 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
912 dev = &rte_crypto_devices[dev_id];
914 if (dev->data->dev_started) {
916 "device %d must be stopped to allow configuration", dev_id);
920 /* Setup new number of queue pairs and reconfigure device. */
921 diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
924 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
929 /* Setup Session mempool for device */
930 return rte_cryptodev_sym_session_pool_create(dev,
931 config->session_mp.nb_objs,
932 config->session_mp.cache_size,
938 rte_cryptodev_start(uint8_t dev_id)
940 struct rte_cryptodev *dev;
943 CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
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 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
954 if (dev->data->dev_started != 0) {
955 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
960 diag = (*dev->dev_ops->dev_start)(dev);
962 dev->data->dev_started = 1;
970 rte_cryptodev_stop(uint8_t dev_id)
972 struct rte_cryptodev *dev;
974 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
975 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
979 dev = &rte_crypto_devices[dev_id];
981 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
983 if (dev->data->dev_started == 0) {
984 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
989 dev->data->dev_started = 0;
990 (*dev->dev_ops->dev_stop)(dev);
994 rte_cryptodev_close(uint8_t dev_id)
996 struct rte_cryptodev *dev;
999 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1000 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1004 dev = &rte_crypto_devices[dev_id];
1006 /* Device must be stopped before it can be closed */
1007 if (dev->data->dev_started == 1) {
1008 CDEV_LOG_ERR("Device %u must be stopped before closing",
1013 /* We can't close the device if there are outstanding sessions in use */
1014 if (dev->data->session_pool != NULL) {
1015 if (!rte_mempool_full(dev->data->session_pool)) {
1016 CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
1017 "has sessions still in use, free "
1018 "all sessions before calling close",
1024 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
1025 retval = (*dev->dev_ops->dev_close)(dev);
1034 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
1035 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id)
1037 struct rte_cryptodev *dev;
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 if (queue_pair_id >= dev->data->nb_queue_pairs) {
1046 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
1050 if (dev->data->dev_started) {
1052 "device %d must be stopped to allow configuration", dev_id);
1056 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
1058 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
1064 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
1066 struct rte_cryptodev *dev;
1068 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1069 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1073 if (stats == NULL) {
1074 CDEV_LOG_ERR("Invalid stats ptr");
1078 dev = &rte_crypto_devices[dev_id];
1079 memset(stats, 0, sizeof(*stats));
1081 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
1082 (*dev->dev_ops->stats_get)(dev, stats);
1087 rte_cryptodev_stats_reset(uint8_t dev_id)
1089 struct rte_cryptodev *dev;
1091 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1092 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1096 dev = &rte_crypto_devices[dev_id];
1098 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
1099 (*dev->dev_ops->stats_reset)(dev);
1104 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
1106 struct rte_cryptodev *dev;
1108 if (dev_id >= cryptodev_globals.nb_devs) {
1109 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1113 dev = &rte_crypto_devices[dev_id];
1115 memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
1117 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
1118 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
1120 dev_info->pci_dev = RTE_DEV_TO_PCI(dev->device);
1122 dev_info->driver_name = dev->driver->pci_drv.driver.name;
1127 rte_cryptodev_callback_register(uint8_t dev_id,
1128 enum rte_cryptodev_event_type event,
1129 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1131 struct rte_cryptodev *dev;
1132 struct rte_cryptodev_callback *user_cb;
1137 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1138 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1142 dev = &rte_crypto_devices[dev_id];
1143 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1145 TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
1146 if (user_cb->cb_fn == cb_fn &&
1147 user_cb->cb_arg == cb_arg &&
1148 user_cb->event == event) {
1153 /* create a new callback. */
1154 if (user_cb == NULL) {
1155 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
1156 sizeof(struct rte_cryptodev_callback), 0);
1157 if (user_cb != NULL) {
1158 user_cb->cb_fn = cb_fn;
1159 user_cb->cb_arg = cb_arg;
1160 user_cb->event = event;
1161 TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
1165 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1166 return (user_cb == NULL) ? -ENOMEM : 0;
1170 rte_cryptodev_callback_unregister(uint8_t dev_id,
1171 enum rte_cryptodev_event_type event,
1172 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
1175 struct rte_cryptodev *dev;
1176 struct rte_cryptodev_callback *cb, *next;
1181 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1182 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1186 dev = &rte_crypto_devices[dev_id];
1187 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1190 for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
1192 next = TAILQ_NEXT(cb, next);
1194 if (cb->cb_fn != cb_fn || cb->event != event ||
1195 (cb->cb_arg != (void *)-1 &&
1196 cb->cb_arg != cb_arg))
1200 * if this callback is not executing right now,
1203 if (cb->active == 0) {
1204 TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
1211 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1216 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
1217 enum rte_cryptodev_event_type event)
1219 struct rte_cryptodev_callback *cb_lst;
1220 struct rte_cryptodev_callback dev_cb;
1222 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1223 TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
1224 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
1228 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1229 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
1231 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1234 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1239 rte_cryptodev_sym_session_init(struct rte_mempool *mp,
1242 __rte_unused unsigned i)
1244 struct rte_cryptodev_sym_session *sess = _sess;
1245 struct rte_cryptodev *dev = opaque_arg;
1247 memset(sess, 0, mp->elt_size);
1249 sess->dev_id = dev->data->dev_id;
1250 sess->dev_type = dev->dev_type;
1253 if (dev->dev_ops->session_initialize)
1254 (*dev->dev_ops->session_initialize)(mp, sess);
1258 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
1259 unsigned nb_objs, unsigned obj_cache_size, int socket_id)
1261 char mp_name[RTE_CRYPTODEV_NAME_MAX_LEN];
1262 unsigned priv_sess_size;
1264 unsigned n = snprintf(mp_name, sizeof(mp_name), "cdev_%d_sess_mp",
1266 if (n > sizeof(mp_name)) {
1267 CDEV_LOG_ERR("Unable to create unique name for session mempool");
1271 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_get_size, -ENOTSUP);
1272 priv_sess_size = (*dev->dev_ops->session_get_size)(dev);
1273 if (priv_sess_size == 0) {
1274 CDEV_LOG_ERR("%s returned and invalid private session size ",
1279 unsigned elt_size = sizeof(struct rte_cryptodev_sym_session) +
1282 dev->data->session_pool = rte_mempool_lookup(mp_name);
1283 if (dev->data->session_pool != NULL) {
1284 if ((dev->data->session_pool->elt_size != elt_size) ||
1285 (dev->data->session_pool->cache_size <
1287 (dev->data->session_pool->size < nb_objs)) {
1289 CDEV_LOG_ERR("%s mempool already exists with different"
1290 " initialization parameters", mp_name);
1291 dev->data->session_pool = NULL;
1295 dev->data->session_pool = rte_mempool_create(
1296 mp_name, /* mempool name */
1297 nb_objs, /* number of elements*/
1298 elt_size, /* element size*/
1299 obj_cache_size, /* Cache size*/
1300 0, /* private data size */
1301 NULL, /* obj initialization constructor */
1302 NULL, /* obj initialization constructor arg */
1303 rte_cryptodev_sym_session_init,
1304 /**< obj constructor*/
1305 dev, /* obj constructor arg */
1306 socket_id, /* socket id */
1309 if (dev->data->session_pool == NULL) {
1310 CDEV_LOG_ERR("%s mempool allocation failed", mp_name);
1315 CDEV_LOG_DEBUG("%s mempool created!", mp_name);
1319 struct rte_cryptodev_sym_session *
1320 rte_cryptodev_sym_session_create(uint8_t dev_id,
1321 struct rte_crypto_sym_xform *xform)
1323 struct rte_cryptodev *dev;
1324 struct rte_cryptodev_sym_session *sess;
1327 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1328 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1332 dev = &rte_crypto_devices[dev_id];
1334 /* Allocate a session structure from the session pool */
1335 if (rte_mempool_get(dev->data->session_pool, &_sess)) {
1336 CDEV_LOG_ERR("Couldn't get object from session mempool");
1340 sess = (struct rte_cryptodev_sym_session *)_sess;
1342 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_configure, NULL);
1343 if (dev->dev_ops->session_configure(dev, xform, sess->_private) ==
1345 CDEV_LOG_ERR("dev_id %d failed to configure session details",
1348 /* Return session to mempool */
1349 rte_mempool_put(sess->mp, _sess);
1356 struct rte_cryptodev_sym_session *
1357 rte_cryptodev_sym_session_free(uint8_t dev_id,
1358 struct rte_cryptodev_sym_session *sess)
1360 struct rte_cryptodev *dev;
1362 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1363 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1367 dev = &rte_crypto_devices[dev_id];
1369 /* Check the session belongs to this device type */
1370 if (sess->dev_type != dev->dev_type)
1373 /* Let device implementation clear session material */
1374 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_clear, sess);
1375 dev->dev_ops->session_clear(dev, (void *)sess->_private);
1377 /* Return session to mempool */
1378 rte_mempool_put(sess->mp, (void *)sess);
1383 /** Initialise rte_crypto_op mempool element */
1385 rte_crypto_op_init(struct rte_mempool *mempool,
1388 __rte_unused unsigned i)
1390 struct rte_crypto_op *op = _op_data;
1391 enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
1393 memset(_op_data, 0, mempool->elt_size);
1395 __rte_crypto_op_reset(op, type);
1397 op->phys_addr = rte_mem_virt2phy(_op_data);
1398 op->mempool = mempool;
1402 struct rte_mempool *
1403 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
1404 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
1407 struct rte_crypto_op_pool_private *priv;
1409 unsigned elt_size = sizeof(struct rte_crypto_op) +
1410 sizeof(struct rte_crypto_sym_op) +
1413 /* lookup mempool in case already allocated */
1414 struct rte_mempool *mp = rte_mempool_lookup(name);
1417 priv = (struct rte_crypto_op_pool_private *)
1418 rte_mempool_get_priv(mp);
1420 if (mp->elt_size != elt_size ||
1421 mp->cache_size < cache_size ||
1422 mp->size < nb_elts ||
1423 priv->priv_size < priv_size) {
1425 CDEV_LOG_ERR("Mempool %s already exists but with "
1426 "incompatible parameters", name);
1432 mp = rte_mempool_create(
1437 sizeof(struct rte_crypto_op_pool_private),
1446 CDEV_LOG_ERR("Failed to create mempool %s", name);
1450 priv = (struct rte_crypto_op_pool_private *)
1451 rte_mempool_get_priv(mp);
1453 priv->priv_size = priv_size;
1460 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix)
1462 struct rte_cryptodev *dev = NULL;
1468 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
1469 int ret = snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
1470 "%s_%u", dev_name_prefix, i);
1475 dev = rte_cryptodev_pmd_get_named_dev(name);