4 * Copyright(c) 2015-2016 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 number_of_sockets(void)
121 const struct rte_memseg *ms = rte_eal_get_physmem_layout();
123 for (i = 0; ((i < RTE_MAX_MEMSEG) && (ms[i].addr != NULL)); i++) {
124 if (sockets < ms[i].socket_id)
125 sockets = ms[i].socket_id;
128 /* Number of sockets = maximum socket_id + 1 */
132 /** Parse integer from integer argument */
134 parse_integer_arg(const char *key __rte_unused,
135 const char *value, void *extra_args)
137 int *i = (int *) extra_args;
141 CDEV_LOG_ERR("Argument has to be positive.");
150 parse_name_arg(const char *key __rte_unused,
151 const char *value, void *extra_args)
153 struct rte_crypto_vdev_init_params *params = extra_args;
155 if (strlen(value) >= RTE_CRYPTODEV_NAME_MAX_LEN - 1) {
156 CDEV_LOG_ERR("Invalid name %s, should be less than "
158 RTE_CRYPTODEV_NAME_MAX_LEN - 1);
162 strncpy(params->name, value, RTE_CRYPTODEV_NAME_MAX_LEN);
168 rte_cryptodev_parse_vdev_init_params(struct rte_crypto_vdev_init_params *params,
169 const char *input_args)
171 struct rte_kvargs *kvlist = NULL;
178 kvlist = rte_kvargs_parse(input_args,
179 cryptodev_vdev_valid_params);
183 ret = rte_kvargs_process(kvlist,
184 RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
186 ¶ms->max_nb_queue_pairs);
190 ret = rte_kvargs_process(kvlist,
191 RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
193 ¶ms->max_nb_sessions);
197 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SOCKET_ID,
203 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_NAME,
209 if (params->socket_id >= number_of_sockets()) {
210 CDEV_LOG_ERR("Invalid socket id specified to create "
211 "the virtual crypto device on");
217 rte_kvargs_free(kvlist);
222 rte_cryptodev_get_feature_name(uint64_t flag)
225 case RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO:
226 return "SYMMETRIC_CRYPTO";
227 case RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO:
228 return "ASYMMETRIC_CRYPTO";
229 case RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING:
230 return "SYM_OPERATION_CHAINING";
231 case RTE_CRYPTODEV_FF_CPU_SSE:
233 case RTE_CRYPTODEV_FF_CPU_AVX:
235 case RTE_CRYPTODEV_FF_CPU_AVX2:
237 case RTE_CRYPTODEV_FF_CPU_AESNI:
239 case RTE_CRYPTODEV_FF_HW_ACCELERATED:
240 return "HW_ACCELERATED";
241 case RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER:
242 return "MBUF_SCATTER_GATHER";
243 case RTE_CRYPTODEV_FF_CPU_NEON:
245 case RTE_CRYPTODEV_FF_CPU_ARM_CE:
253 rte_cryptodev_create_vdev(const char *name, const char *args)
255 return rte_eal_vdev_init(name, args);
258 struct rte_cryptodev *
259 rte_cryptodev_pmd_get_dev(uint8_t dev_id)
261 return &rte_cryptodev_globals->devs[dev_id];
264 struct rte_cryptodev *
265 rte_cryptodev_pmd_get_named_dev(const char *name)
267 struct rte_cryptodev *dev;
273 for (i = 0; i < rte_cryptodev_globals->max_devs; i++) {
274 dev = &rte_cryptodev_globals->devs[i];
276 if ((dev->attached == RTE_CRYPTODEV_ATTACHED) &&
277 (strcmp(dev->data->name, name) == 0))
285 rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
287 struct rte_cryptodev *dev = NULL;
289 if (dev_id >= rte_cryptodev_globals->nb_devs)
292 dev = rte_cryptodev_pmd_get_dev(dev_id);
293 if (dev->attached != RTE_CRYPTODEV_ATTACHED)
301 rte_cryptodev_get_dev_id(const char *name)
308 for (i = 0; i < rte_cryptodev_globals->nb_devs; i++)
309 if ((strcmp(rte_cryptodev_globals->devs[i].data->name, name)
311 (rte_cryptodev_globals->devs[i].attached ==
312 RTE_CRYPTODEV_ATTACHED))
319 rte_cryptodev_count(void)
321 return rte_cryptodev_globals->nb_devs;
325 rte_cryptodev_count_devtype(enum rte_cryptodev_type type)
327 uint8_t i, dev_count = 0;
329 for (i = 0; i < rte_cryptodev_globals->max_devs; i++)
330 if (rte_cryptodev_globals->devs[i].dev_type == type &&
331 rte_cryptodev_globals->devs[i].attached ==
332 RTE_CRYPTODEV_ATTACHED)
339 rte_cryptodev_socket_id(uint8_t dev_id)
341 struct rte_cryptodev *dev;
343 if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
346 dev = rte_cryptodev_pmd_get_dev(dev_id);
348 return dev->data->socket_id;
352 rte_cryptodev_data_alloc(uint8_t dev_id, struct rte_cryptodev_data **data,
355 char mz_name[RTE_CRYPTODEV_NAME_MAX_LEN];
356 const struct rte_memzone *mz;
359 /* generate memzone name */
360 n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
361 if (n >= (int)sizeof(mz_name))
364 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
365 mz = rte_memzone_reserve(mz_name,
366 sizeof(struct rte_cryptodev_data),
369 mz = rte_memzone_lookup(mz_name);
375 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
376 memset(*data, 0, sizeof(struct rte_cryptodev_data));
382 rte_cryptodev_find_free_device_index(void)
386 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) {
387 if (rte_crypto_devices[dev_id].attached ==
388 RTE_CRYPTODEV_DETACHED)
391 return RTE_CRYPTO_MAX_DEVS;
394 struct rte_cryptodev *
395 rte_cryptodev_pmd_allocate(const char *name, int socket_id)
397 struct rte_cryptodev *cryptodev;
400 if (rte_cryptodev_pmd_get_named_dev(name) != NULL) {
401 CDEV_LOG_ERR("Crypto device with name %s already "
406 dev_id = rte_cryptodev_find_free_device_index();
407 if (dev_id == RTE_CRYPTO_MAX_DEVS) {
408 CDEV_LOG_ERR("Reached maximum number of crypto devices");
412 cryptodev = rte_cryptodev_pmd_get_dev(dev_id);
414 if (cryptodev->data == NULL) {
415 struct rte_cryptodev_data *cryptodev_data =
416 cryptodev_globals.data[dev_id];
418 int retval = rte_cryptodev_data_alloc(dev_id, &cryptodev_data,
421 if (retval < 0 || cryptodev_data == NULL)
424 cryptodev->data = cryptodev_data;
426 snprintf(cryptodev->data->name, RTE_CRYPTODEV_NAME_MAX_LEN,
429 cryptodev->data->dev_id = dev_id;
430 cryptodev->data->socket_id = socket_id;
431 cryptodev->data->dev_started = 0;
433 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
435 cryptodev_globals.nb_devs++;
442 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
446 if (cryptodev == NULL)
449 ret = rte_cryptodev_close(cryptodev->data->dev_id);
453 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
454 cryptodev_globals.nb_devs--;
458 struct rte_cryptodev *
459 rte_cryptodev_pmd_virtual_dev_init(const char *name, size_t dev_private_size,
462 struct rte_cryptodev *cryptodev;
464 /* allocate device structure */
465 cryptodev = rte_cryptodev_pmd_allocate(name, socket_id);
466 if (cryptodev == NULL)
469 /* allocate private device structure */
470 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
471 cryptodev->data->dev_private =
472 rte_zmalloc_socket("cryptodev device private",
477 if (cryptodev->data->dev_private == NULL)
478 rte_panic("Cannot allocate memzone for private device"
482 /* initialise user call-back tail queue */
483 TAILQ_INIT(&(cryptodev->link_intr_cbs));
489 rte_cryptodev_pci_probe(struct rte_pci_driver *pci_drv,
490 struct rte_pci_device *pci_dev)
492 struct rte_cryptodev_driver *cryptodrv;
493 struct rte_cryptodev *cryptodev;
495 char cryptodev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
499 cryptodrv = (struct rte_cryptodev_driver *)pci_drv;
500 if (cryptodrv == NULL)
503 rte_eal_pci_device_name(&pci_dev->addr, cryptodev_name,
504 sizeof(cryptodev_name));
506 cryptodev = rte_cryptodev_pmd_allocate(cryptodev_name, rte_socket_id());
507 if (cryptodev == NULL)
510 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
511 cryptodev->data->dev_private =
513 "cryptodev private structure",
514 cryptodrv->dev_private_size,
518 if (cryptodev->data->dev_private == NULL)
519 rte_panic("Cannot allocate memzone for private "
523 cryptodev->device = &pci_dev->device;
524 cryptodev->driver = cryptodrv;
526 /* init user callbacks */
527 TAILQ_INIT(&(cryptodev->link_intr_cbs));
529 /* Invoke PMD device initialization function */
530 retval = (*cryptodrv->cryptodev_init)(cryptodrv, cryptodev);
534 CDEV_LOG_ERR("driver %s: crypto_dev_init(vendor_id=0x%x device_id=0x%x)"
535 " failed", pci_drv->driver.name,
536 (unsigned) pci_dev->id.vendor_id,
537 (unsigned) pci_dev->id.device_id);
539 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
540 rte_free(cryptodev->data->dev_private);
542 cryptodev->attached = RTE_CRYPTODEV_DETACHED;
543 cryptodev_globals.nb_devs--;
549 rte_cryptodev_pci_remove(struct rte_pci_device *pci_dev)
551 const struct rte_cryptodev_driver *cryptodrv;
552 struct rte_cryptodev *cryptodev;
553 char cryptodev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
559 rte_eal_pci_device_name(&pci_dev->addr, cryptodev_name,
560 sizeof(cryptodev_name));
562 cryptodev = rte_cryptodev_pmd_get_named_dev(cryptodev_name);
563 if (cryptodev == NULL)
566 cryptodrv = (const struct rte_cryptodev_driver *)pci_dev->driver;
567 if (cryptodrv == NULL)
570 /* Invoke PMD device uninit function */
571 if (*cryptodrv->cryptodev_uninit) {
572 ret = (*cryptodrv->cryptodev_uninit)(cryptodrv, cryptodev);
577 /* free crypto device */
578 rte_cryptodev_pmd_release_device(cryptodev);
580 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
581 rte_free(cryptodev->data->dev_private);
583 cryptodev->device = NULL;
584 cryptodev->driver = NULL;
585 cryptodev->data = NULL;
591 rte_cryptodev_queue_pair_count(uint8_t dev_id)
593 struct rte_cryptodev *dev;
595 dev = &rte_crypto_devices[dev_id];
596 return dev->data->nb_queue_pairs;
600 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
603 struct rte_cryptodev_info dev_info;
607 if ((dev == NULL) || (nb_qpairs < 1)) {
608 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
613 CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
614 nb_qpairs, dev->data->dev_id);
616 memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
618 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
619 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
621 if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
622 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
623 nb_qpairs, dev->data->dev_id);
627 if (dev->data->queue_pairs == NULL) { /* first time configuration */
628 dev->data->queue_pairs = rte_zmalloc_socket(
629 "cryptodev->queue_pairs",
630 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
631 RTE_CACHE_LINE_SIZE, socket_id);
633 if (dev->data->queue_pairs == NULL) {
634 dev->data->nb_queue_pairs = 0;
635 CDEV_LOG_ERR("failed to get memory for qp meta data, "
640 } else { /* re-configure */
642 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
644 qp = dev->data->queue_pairs;
646 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
649 for (i = nb_qpairs; i < old_nb_queues; i++) {
650 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
655 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
656 RTE_CACHE_LINE_SIZE);
658 CDEV_LOG_ERR("failed to realloc qp meta data,"
659 " nb_queues %u", nb_qpairs);
663 if (nb_qpairs > old_nb_queues) {
664 uint16_t new_qs = nb_qpairs - old_nb_queues;
666 memset(qp + old_nb_queues, 0,
667 sizeof(qp[0]) * new_qs);
670 dev->data->queue_pairs = qp;
673 dev->data->nb_queue_pairs = nb_qpairs;
678 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id)
680 struct rte_cryptodev *dev;
682 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
683 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
687 dev = &rte_crypto_devices[dev_id];
688 if (queue_pair_id >= dev->data->nb_queue_pairs) {
689 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
693 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_start, -ENOTSUP);
695 return dev->dev_ops->queue_pair_start(dev, queue_pair_id);
700 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id)
702 struct rte_cryptodev *dev;
704 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
705 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
709 dev = &rte_crypto_devices[dev_id];
710 if (queue_pair_id >= dev->data->nb_queue_pairs) {
711 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
715 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_stop, -ENOTSUP);
717 return dev->dev_ops->queue_pair_stop(dev, queue_pair_id);
722 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
723 unsigned nb_objs, unsigned obj_cache_size, int socket_id);
726 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
728 struct rte_cryptodev *dev;
731 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
732 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
736 dev = &rte_crypto_devices[dev_id];
738 if (dev->data->dev_started) {
740 "device %d must be stopped to allow configuration", dev_id);
744 /* Setup new number of queue pairs and reconfigure device. */
745 diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
748 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
753 /* Setup Session mempool for device */
754 return rte_cryptodev_sym_session_pool_create(dev,
755 config->session_mp.nb_objs,
756 config->session_mp.cache_size,
762 rte_cryptodev_start(uint8_t dev_id)
764 struct rte_cryptodev *dev;
767 CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
769 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
770 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
774 dev = &rte_crypto_devices[dev_id];
776 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
778 if (dev->data->dev_started != 0) {
779 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
784 diag = (*dev->dev_ops->dev_start)(dev);
786 dev->data->dev_started = 1;
794 rte_cryptodev_stop(uint8_t dev_id)
796 struct rte_cryptodev *dev;
798 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
799 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
803 dev = &rte_crypto_devices[dev_id];
805 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
807 if (dev->data->dev_started == 0) {
808 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
813 dev->data->dev_started = 0;
814 (*dev->dev_ops->dev_stop)(dev);
818 rte_cryptodev_close(uint8_t dev_id)
820 struct rte_cryptodev *dev;
823 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
824 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
828 dev = &rte_crypto_devices[dev_id];
830 /* Device must be stopped before it can be closed */
831 if (dev->data->dev_started == 1) {
832 CDEV_LOG_ERR("Device %u must be stopped before closing",
837 /* We can't close the device if there are outstanding sessions in use */
838 if (dev->data->session_pool != NULL) {
839 if (!rte_mempool_full(dev->data->session_pool)) {
840 CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
841 "has sessions still in use, free "
842 "all sessions before calling close",
848 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
849 retval = (*dev->dev_ops->dev_close)(dev);
858 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
859 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id)
861 struct rte_cryptodev *dev;
863 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
864 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
868 dev = &rte_crypto_devices[dev_id];
869 if (queue_pair_id >= dev->data->nb_queue_pairs) {
870 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
874 if (dev->data->dev_started) {
876 "device %d must be stopped to allow configuration", dev_id);
880 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
882 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
888 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
890 struct rte_cryptodev *dev;
892 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
893 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
898 CDEV_LOG_ERR("Invalid stats ptr");
902 dev = &rte_crypto_devices[dev_id];
903 memset(stats, 0, sizeof(*stats));
905 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
906 (*dev->dev_ops->stats_get)(dev, stats);
911 rte_cryptodev_stats_reset(uint8_t dev_id)
913 struct rte_cryptodev *dev;
915 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
916 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
920 dev = &rte_crypto_devices[dev_id];
922 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
923 (*dev->dev_ops->stats_reset)(dev);
928 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
930 struct rte_cryptodev *dev;
932 if (dev_id >= cryptodev_globals.nb_devs) {
933 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
937 dev = &rte_crypto_devices[dev_id];
939 memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
941 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
942 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
944 dev_info->pci_dev = RTE_DEV_TO_PCI(dev->device);
946 dev_info->driver_name = dev->driver->pci_drv.driver.name;
951 rte_cryptodev_callback_register(uint8_t dev_id,
952 enum rte_cryptodev_event_type event,
953 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
955 struct rte_cryptodev *dev;
956 struct rte_cryptodev_callback *user_cb;
961 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
962 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
966 dev = &rte_crypto_devices[dev_id];
967 rte_spinlock_lock(&rte_cryptodev_cb_lock);
969 TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
970 if (user_cb->cb_fn == cb_fn &&
971 user_cb->cb_arg == cb_arg &&
972 user_cb->event == event) {
977 /* create a new callback. */
978 if (user_cb == NULL) {
979 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
980 sizeof(struct rte_cryptodev_callback), 0);
981 if (user_cb != NULL) {
982 user_cb->cb_fn = cb_fn;
983 user_cb->cb_arg = cb_arg;
984 user_cb->event = event;
985 TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
989 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
990 return (user_cb == NULL) ? -ENOMEM : 0;
994 rte_cryptodev_callback_unregister(uint8_t dev_id,
995 enum rte_cryptodev_event_type event,
996 rte_cryptodev_cb_fn cb_fn, void *cb_arg)
999 struct rte_cryptodev *dev;
1000 struct rte_cryptodev_callback *cb, *next;
1005 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1006 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
1010 dev = &rte_crypto_devices[dev_id];
1011 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1014 for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
1016 next = TAILQ_NEXT(cb, next);
1018 if (cb->cb_fn != cb_fn || cb->event != event ||
1019 (cb->cb_arg != (void *)-1 &&
1020 cb->cb_arg != cb_arg))
1024 * if this callback is not executing right now,
1027 if (cb->active == 0) {
1028 TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
1035 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1040 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
1041 enum rte_cryptodev_event_type event)
1043 struct rte_cryptodev_callback *cb_lst;
1044 struct rte_cryptodev_callback dev_cb;
1046 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1047 TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
1048 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
1052 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1053 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
1055 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1058 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1063 rte_cryptodev_sym_session_init(struct rte_mempool *mp,
1066 __rte_unused unsigned i)
1068 struct rte_cryptodev_sym_session *sess = _sess;
1069 struct rte_cryptodev *dev = opaque_arg;
1071 memset(sess, 0, mp->elt_size);
1073 sess->dev_id = dev->data->dev_id;
1074 sess->dev_type = dev->dev_type;
1077 if (dev->dev_ops->session_initialize)
1078 (*dev->dev_ops->session_initialize)(mp, sess);
1082 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
1083 unsigned nb_objs, unsigned obj_cache_size, int socket_id)
1085 char mp_name[RTE_CRYPTODEV_NAME_MAX_LEN];
1086 unsigned priv_sess_size;
1088 unsigned n = snprintf(mp_name, sizeof(mp_name), "cdev_%d_sess_mp",
1090 if (n > sizeof(mp_name)) {
1091 CDEV_LOG_ERR("Unable to create unique name for session mempool");
1095 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_get_size, -ENOTSUP);
1096 priv_sess_size = (*dev->dev_ops->session_get_size)(dev);
1097 if (priv_sess_size == 0) {
1098 CDEV_LOG_ERR("%s returned and invalid private session size ",
1103 unsigned elt_size = sizeof(struct rte_cryptodev_sym_session) +
1106 dev->data->session_pool = rte_mempool_lookup(mp_name);
1107 if (dev->data->session_pool != NULL) {
1108 if ((dev->data->session_pool->elt_size != elt_size) ||
1109 (dev->data->session_pool->cache_size <
1111 (dev->data->session_pool->size < nb_objs)) {
1113 CDEV_LOG_ERR("%s mempool already exists with different"
1114 " initialization parameters", mp_name);
1115 dev->data->session_pool = NULL;
1119 dev->data->session_pool = rte_mempool_create(
1120 mp_name, /* mempool name */
1121 nb_objs, /* number of elements*/
1122 elt_size, /* element size*/
1123 obj_cache_size, /* Cache size*/
1124 0, /* private data size */
1125 NULL, /* obj initialization constructor */
1126 NULL, /* obj initialization constructor arg */
1127 rte_cryptodev_sym_session_init,
1128 /**< obj constructor*/
1129 dev, /* obj constructor arg */
1130 socket_id, /* socket id */
1133 if (dev->data->session_pool == NULL) {
1134 CDEV_LOG_ERR("%s mempool allocation failed", mp_name);
1139 CDEV_LOG_DEBUG("%s mempool created!", mp_name);
1143 struct rte_cryptodev_sym_session *
1144 rte_cryptodev_sym_session_create(uint8_t dev_id,
1145 struct rte_crypto_sym_xform *xform)
1147 struct rte_cryptodev *dev;
1148 struct rte_cryptodev_sym_session *sess;
1151 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1152 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1156 dev = &rte_crypto_devices[dev_id];
1158 /* Allocate a session structure from the session pool */
1159 if (rte_mempool_get(dev->data->session_pool, &_sess)) {
1160 CDEV_LOG_ERR("Couldn't get object from session mempool");
1164 sess = (struct rte_cryptodev_sym_session *)_sess;
1166 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_configure, NULL);
1167 if (dev->dev_ops->session_configure(dev, xform, sess->_private) ==
1169 CDEV_LOG_ERR("dev_id %d failed to configure session details",
1172 /* Return session to mempool */
1173 rte_mempool_put(sess->mp, _sess);
1180 struct rte_cryptodev_sym_session *
1181 rte_cryptodev_sym_session_free(uint8_t dev_id,
1182 struct rte_cryptodev_sym_session *sess)
1184 struct rte_cryptodev *dev;
1186 if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1187 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1191 dev = &rte_crypto_devices[dev_id];
1193 /* Check the session belongs to this device type */
1194 if (sess->dev_type != dev->dev_type)
1197 /* Let device implementation clear session material */
1198 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_clear, sess);
1199 dev->dev_ops->session_clear(dev, (void *)sess->_private);
1201 /* Return session to mempool */
1202 rte_mempool_put(sess->mp, (void *)sess);
1207 /** Initialise rte_crypto_op mempool element */
1209 rte_crypto_op_init(struct rte_mempool *mempool,
1212 __rte_unused unsigned i)
1214 struct rte_crypto_op *op = _op_data;
1215 enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
1217 memset(_op_data, 0, mempool->elt_size);
1219 __rte_crypto_op_reset(op, type);
1221 op->phys_addr = rte_mem_virt2phy(_op_data);
1222 op->mempool = mempool;
1226 struct rte_mempool *
1227 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
1228 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
1231 struct rte_crypto_op_pool_private *priv;
1233 unsigned elt_size = sizeof(struct rte_crypto_op) +
1234 sizeof(struct rte_crypto_sym_op) +
1237 /* lookup mempool in case already allocated */
1238 struct rte_mempool *mp = rte_mempool_lookup(name);
1241 priv = (struct rte_crypto_op_pool_private *)
1242 rte_mempool_get_priv(mp);
1244 if (mp->elt_size != elt_size ||
1245 mp->cache_size < cache_size ||
1246 mp->size < nb_elts ||
1247 priv->priv_size < priv_size) {
1249 CDEV_LOG_ERR("Mempool %s already exists but with "
1250 "incompatible parameters", name);
1256 mp = rte_mempool_create(
1261 sizeof(struct rte_crypto_op_pool_private),
1270 CDEV_LOG_ERR("Failed to create mempool %s", name);
1274 priv = (struct rte_crypto_op_pool_private *)
1275 rte_mempool_get_priv(mp);
1277 priv->priv_size = priv_size;
1284 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix)
1286 struct rte_cryptodev *dev = NULL;
1292 for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
1293 int ret = snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
1294 "%s_%u", dev_name_prefix, i);
1299 dev = rte_cryptodev_pmd_get_named_dev(name);